{"openapi":"3.1.0","info":{"title":"ShelfCycle Public API","version":"v1.47.0","description":"Machine-readable contract for ShelfCycle's public API. Contract v1.47.0 remains on the /api/v1 route family and supports sales-order and purchase-order finder and detail reads with signed continuation, exact document currency, current lifecycle evidence, Certification Intelligence for stored records, plus the existing master-data, document, report, note, and Cost Book capabilities. Each request follows the fields and rules documented for its endpoint."},"servers":[{"url":"https://app.shelfcycle.com","description":"Current ShelfCycle application host"}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"ShelfCycle API key","description":"Send Authorization: Bearer sk_... for authenticated public API routes."}},"schemas":{"PublicAPIErrorEnvelope":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false},"PublicAPIMeResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"apiVersion":{"type":"string","enum":["v1"]},"apiContractVersion":{"type":"string","enum":["v1.47.0"]},"minimumCompatibleContractVersion":{"type":"string","enum":["v1.21"]},"org":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"baseCurrencyCode":{"type":"string","minLength":3,"maxLength":3}},"required":["id","name","baseCurrencyCode"],"additionalProperties":false},"key":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"purpose":{"type":["string","null"]},"preview":{"type":"string"},"scopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"accessMode":{"type":"string","enum":["restricted","full"]},"storedGrants":{"type":"array","items":{"type":"string"}},"effectiveScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"retiredScopes":{"type":"array","items":{"type":"string"}},"expiresAt":{"type":["string","null"],"format":"date-time"}},"required":["id","name","purpose","preview","scopes","accessMode","storedGrants","effectiveScopes","retiredScopes","expiresAt"],"additionalProperties":false},"actor":{"type":"object","properties":{"type":{"type":"string","enum":["user"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"documentation":{"type":"object","properties":{"openapiJsonUrl":{"type":"string"},"llmsTxtUrl":{"type":"string"}},"required":["openapiJsonUrl","llmsTxtUrl"],"additionalProperties":false},"effectiveCapabilities":{"type":"object","properties":{"documentUploads":{"type":"object","properties":{"create":{"type":"boolean"}},"required":["create"],"additionalProperties":false},"search":{"type":"object","properties":{"viewableTypes":{"type":"array","items":{"type":"string","enum":["customer","supplier","contact","product","order","purchase_order","location"]}}},"required":["viewableTypes"],"additionalProperties":false},"entityResolution":{"type":"object","properties":{"viewableClasses":{"type":"array","items":{"type":"string","enum":["customer","supplier","product","product_family","sales_order","purchase_order","salesperson","warehouse"]}}},"required":["viewableClasses"],"additionalProperties":false},"warehouses":{"type":"object","properties":{"view":{"type":"boolean"},"create":{"type":"boolean"},"update":{"type":"boolean"},"archive":{"type":"boolean"},"unarchive":{"type":"boolean"}},"required":["view","create","update","archive","unarchive"],"additionalProperties":false},"shippingOptions":{"type":"object","properties":{"view":{"type":"boolean"},"create":{"type":"boolean"},"update":{"type":"boolean"},"archive":{"type":"boolean"},"unarchive":{"type":"boolean"}},"required":["view","create","update","archive","unarchive"],"additionalProperties":false},"reorderPoints":{"type":"object","properties":{"write":{"type":"boolean"}},"required":["write"],"additionalProperties":false},"tags":{"type":"object","properties":{"vocabulary":{"type":"boolean"},"viewableEntityTypes":{"type":"array","items":{"type":"string","enum":["supplier","customer","product","product_family","contact","opportunity","sales_order","purchase_order","ship_to_address","ship_from_address"]}}},"required":["vocabulary","viewableEntityTypes"],"additionalProperties":false},"productDirectory":{"type":"object","properties":{"view":{"type":"boolean"},"createdRecordDiscovery":{"type":"boolean"}},"required":["view","createdRecordDiscovery"],"additionalProperties":false},"notes":{"type":"object","properties":{"create":{"type":"boolean"},"view":{"type":"boolean"},"update":{"type":"boolean"},"activityReport":{"type":"boolean"},"viewableSubjectTypes":{"type":"array","items":{"type":"string","enum":["customer","supplier","product"]}},"readableSubjectTypes":{"type":"array","items":{"type":"string","enum":["customer","supplier","product"]}}},"required":["create","view","update","activityReport","viewableSubjectTypes","readableSubjectTypes"],"additionalProperties":false},"sentEmails":{"type":"object","properties":{"activityReport":{"type":"boolean"}},"required":["activityReport"],"additionalProperties":false},"opportunities":{"type":"object","properties":{"view":{"type":"boolean"},"createdRecordDiscovery":{"type":"boolean"},"create":{"type":"boolean"},"update":{"type":"boolean"},"close":{"type":"boolean"},"metaUpsert":{"type":"boolean"}},"required":["view","createdRecordDiscovery","create","update","close","metaUpsert"],"additionalProperties":false},"contacts":{"type":"object","properties":{"create":{"type":"boolean"},"view":{"type":"boolean"},"update":{"type":"boolean"},"archive":{"type":"boolean"},"unarchive":{"type":"boolean"},"customer":{"type":"object","properties":{"create":{"type":"boolean"},"view":{"type":"boolean"},"update":{"type":"boolean"},"archive":{"type":"boolean"},"unarchive":{"type":"boolean"}},"required":["create","view","update","archive","unarchive"],"additionalProperties":false},"supplier":{"type":"object","properties":{"create":{"type":"boolean"},"view":{"type":"boolean"},"update":{"type":"boolean"},"archive":{"type":"boolean"},"unarchive":{"type":"boolean"}},"required":["create","view","update","archive","unarchive"],"additionalProperties":false}},"required":["create","view","update","archive","unarchive","customer","supplier"],"additionalProperties":false},"customers":{"type":"object","properties":{"view":{"type":"boolean"},"create":{"type":"boolean"},"update":{"type":"boolean"},"archive":{"type":"boolean"},"unarchive":{"type":"boolean"},"activityFilter":{"type":"boolean"},"createdRecordDiscovery":{"type":"boolean"},"locations":{"type":"object","properties":{"view":{"type":"boolean"},"create":{"type":"boolean"},"update":{"type":"boolean"}},"required":["view","create","update"],"additionalProperties":false},"addresses":{"type":"object","properties":{"view":{"type":"boolean"},"create":{"type":"boolean"},"update":{"type":"boolean"},"archive":{"type":"boolean"},"unarchive":{"type":"boolean"}},"required":["view","create","update","archive","unarchive"],"additionalProperties":false},"documents":{"type":"object","properties":{"view":{"type":"boolean"},"create":{"type":"boolean"}},"required":["view","create"],"additionalProperties":false}},"required":["view","create","update","archive","unarchive","activityFilter","createdRecordDiscovery","locations","addresses","documents"],"additionalProperties":false},"suppliers":{"type":"object","properties":{"view":{"type":"boolean"},"createdRecordDiscovery":{"type":"boolean"},"create":{"type":"boolean"},"update":{"type":"boolean"},"archive":{"type":"boolean"},"unarchive":{"type":"boolean"},"shipFromLocations":{"type":"object","properties":{"view":{"type":"boolean"},"create":{"type":"boolean"},"update":{"type":"boolean"},"archive":{"type":"boolean"},"unarchive":{"type":"boolean"}},"required":["view","create","update","archive","unarchive"],"additionalProperties":false},"documents":{"type":"object","properties":{"view":{"type":"boolean"},"create":{"type":"boolean"}},"required":["view","create"],"additionalProperties":false}},"required":["view","createdRecordDiscovery","create","update","archive","unarchive","shipFromLocations","documents"],"additionalProperties":false},"companyReference":{"type":"object","properties":{"activeDirectory":{"type":"boolean"},"customers":{"type":"boolean"},"suppliers":{"type":"boolean"},"representatives":{"type":"boolean"},"paymentTerms":{"type":"boolean"},"ledgerAccounts":{"type":"boolean"},"write":{"type":"object","properties":{"salesRepresentatives":{"type":"boolean"},"customerServiceRepresentatives":{"type":"boolean"},"supplierRepresentatives":{"type":"boolean"},"paymentTermsCreate":{"type":"boolean"},"paymentTermsMetadataUpdate":{"type":"boolean"},"ledgerAccountsCreate":{"type":"boolean"},"ledgerAccountsUpdate":{"type":"boolean"}},"required":["salesRepresentatives","customerServiceRepresentatives","supplierRepresentatives","paymentTermsCreate","paymentTermsMetadataUpdate","ledgerAccountsCreate","ledgerAccountsUpdate"],"additionalProperties":false}},"required":["activeDirectory","customers","suppliers","representatives","paymentTerms","ledgerAccounts","write"],"additionalProperties":false},"products":{"type":"object","properties":{"view":{"type":"boolean"},"create":{"type":"boolean"},"update":{"type":"boolean"},"archive":{"type":"boolean"},"unarchive":{"type":"boolean"},"packaging":{"type":"object","properties":{"view":{"type":"boolean"},"create":{"type":"boolean"}},"required":["view","create"],"additionalProperties":false},"codeAttributes":{"type":"object","properties":{"view":{"type":"boolean"}},"required":["view"],"additionalProperties":false},"attributeAssignments":{"type":"object","properties":{"view":{"type":"boolean"},"update":{"type":"boolean"}},"required":["view","update"],"additionalProperties":false},"suppliers":{"type":"object","properties":{"view":{"type":"boolean"},"create":{"type":"boolean"},"remove":{"type":"boolean"}},"required":["view","create","remove"],"additionalProperties":false},"aliases":{"type":"object","properties":{"view":{"type":"boolean"},"create":{"type":"boolean"},"update":{"type":"boolean"},"remove":{"type":"boolean"}},"required":["view","create","update","remove"],"additionalProperties":false},"customerPartNumbers":{"type":"object","properties":{"view":{"type":"boolean"},"create":{"type":"boolean"},"update":{"type":"boolean"},"remove":{"type":"boolean"}},"required":["view","create","update","remove"],"additionalProperties":false},"documents":{"type":"object","properties":{"view":{"type":"boolean"},"create":{"type":"boolean"}},"required":["view","create"],"additionalProperties":false},"sds":{"type":"object","properties":{"view":{"type":"boolean"},"update":{"type":"boolean"}},"required":["view","update"],"additionalProperties":false}},"required":["view","create","update","archive","unarchive","packaging","codeAttributes","attributeAssignments","suppliers","aliases","customerPartNumbers","documents","sds"],"additionalProperties":false},"productFamilies":{"type":"object","properties":{"view":{"type":"boolean"},"create":{"type":"boolean"},"update":{"type":"boolean"},"aliases":{"type":"object","properties":{"view":{"type":"boolean"},"create":{"type":"boolean"},"update":{"type":"boolean"},"remove":{"type":"boolean"}},"required":["view","create","update","remove"],"additionalProperties":false}},"required":["view","create","update","aliases"],"additionalProperties":false},"costBookEntries":{"type":"object","properties":{"view":{"type":"boolean"},"createdRecordDiscovery":{"type":"boolean"},"create":{"type":"boolean"},"delete":{"type":"boolean"}},"required":["view","createdRecordDiscovery","create","delete"],"additionalProperties":false},"currentCostSources":{"type":"object","properties":{"read":{"type":"boolean"},"write":{"type":"boolean"}},"required":["read","write"],"additionalProperties":false},"priceBookEntries":{"type":"object","properties":{"read":{"type":"boolean"},"createdRecordDiscovery":{"type":"boolean"},"write":{"type":"boolean"},"writeCurrencyMode":{"type":"string","enum":["org_base_only"]}},"required":["read","createdRecordDiscovery","write","writeCurrencyMode"],"additionalProperties":false},"orders":{"type":"object","properties":{"view":{"type":"boolean"},"createdRecordDiscovery":{"type":"boolean"},"changedRecordDiscovery":{"type":"boolean"}},"required":["view","createdRecordDiscovery","changedRecordDiscovery"],"additionalProperties":false},"purchaseOrders":{"type":"object","properties":{"view":{"type":"boolean"},"createdRecordDiscovery":{"type":"boolean"},"changedRecordDiscovery":{"type":"boolean"},"execution":{"type":"object","properties":{"view":{"type":"boolean"},"currentStateRefresh":{"type":"boolean"}},"required":["view","currentStateRefresh"],"additionalProperties":false},"documents":{"type":"object","properties":{"view":{"type":"boolean"},"create":{"type":"boolean"}},"required":["view","create"],"additionalProperties":false}},"required":["view","createdRecordDiscovery","changedRecordDiscovery","execution","documents"],"additionalProperties":false},"inventory":{"type":"object","properties":{"balances":{"type":"object","properties":{"view":{"type":"boolean"},"currentStateRefresh":{"type":"boolean"}},"required":["view","currentStateRefresh"],"additionalProperties":false},"lots":{"type":"object","properties":{"view":{"type":"boolean"},"createdRecordDiscovery":{"type":"boolean"},"currentStateRefresh":{"type":"boolean"}},"required":["view","createdRecordDiscovery","currentStateRefresh"],"additionalProperties":false}},"required":["balances","lots"],"additionalProperties":false},"reorder":{"type":"object","properties":{"status":{"type":"object","properties":{"view":{"type":"boolean"},"currentStateRefresh":{"type":"boolean"}},"required":["view","currentStateRefresh"],"additionalProperties":false}},"required":["status"],"additionalProperties":false},"certifications":{"type":"object","properties":{"view":{"type":"boolean"},"createdRecordDiscovery":{"type":"boolean"},"viewableSubjectTypes":{"type":"array","items":{"type":"string","enum":["supplier","customer","product","customer_address","warehouse","supplier_combination"]}}},"required":["view","createdRecordDiscovery","viewableSubjectTypes"],"additionalProperties":false},"reports":{"type":"object","properties":{"available":{"type":"array","items":{"type":"string","enum":["sales-summary","purchase-summary","open-sales-orders","ap-aging","payments-received","payments-made","ar-aging","pipeline-summary","customer-invoice-settlement-behavior","customer-credit-exposure","customer-invoice-charges"]}}},"required":["available"],"additionalProperties":false},"writeReadiness":{"type":"object","properties":{"warehouses":{"type":"object","properties":{"create":{"type":"boolean"},"update":{"type":"boolean"},"archive":{"type":"boolean"},"unarchive":{"type":"boolean"}},"required":["create","update","archive","unarchive"],"additionalProperties":false},"shippingOptions":{"type":"object","properties":{"create":{"type":"boolean"},"update":{"type":"boolean"},"archive":{"type":"boolean"},"unarchive":{"type":"boolean"}},"required":["create","update","archive","unarchive"],"additionalProperties":false},"reorderPoints":{"type":"object","properties":{"write":{"type":"boolean"}},"required":["write"],"additionalProperties":false},"tags":{"type":"object","properties":{"create":{"type":"boolean"},"update":{"type":"boolean"},"assignableEntityTypes":{"type":"array","items":{"type":"string","enum":["supplier","customer","product","product_family","contact","opportunity","sales_order","purchase_order","ship_to_address","ship_from_address"]}}},"required":["create","update","assignableEntityTypes"],"additionalProperties":false},"notes":{"type":"object","properties":{"create":{"type":"boolean"},"update":{"type":"boolean"}},"required":["create","update"],"additionalProperties":false},"opportunities":{"type":"object","properties":{"create":{"type":"boolean"},"update":{"type":"boolean"},"close":{"type":"boolean"},"metaUpsert":{"type":"boolean"}},"required":["create","update","close","metaUpsert"],"additionalProperties":false},"contacts":{"type":"object","properties":{"create":{"type":"boolean"},"update":{"type":"boolean"},"archive":{"type":"boolean"},"unarchive":{"type":"boolean"},"customer":{"type":"object","properties":{"create":{"type":"boolean"},"update":{"type":"boolean"},"archive":{"type":"boolean"},"unarchive":{"type":"boolean"}},"required":["create","update","archive","unarchive"],"additionalProperties":false},"supplier":{"type":"object","properties":{"create":{"type":"boolean"},"update":{"type":"boolean"},"archive":{"type":"boolean"},"unarchive":{"type":"boolean"}},"required":["create","update","archive","unarchive"],"additionalProperties":false}},"required":["create","update","archive","unarchive","customer","supplier"],"additionalProperties":false},"customers":{"type":"object","properties":{"create":{"type":"boolean"},"update":{"type":"boolean"},"archive":{"type":"boolean"},"unarchive":{"type":"boolean"},"locations":{"type":"object","properties":{"create":{"type":"boolean"},"update":{"type":"boolean"}},"required":["create","update"],"additionalProperties":false},"addresses":{"type":"object","properties":{"create":{"type":"boolean"},"update":{"type":"boolean"},"archive":{"type":"boolean"},"unarchive":{"type":"boolean"}},"required":["create","update","archive","unarchive"],"additionalProperties":false},"documents":{"type":"object","properties":{"create":{"type":"boolean"}},"required":["create"],"additionalProperties":false}},"required":["create","update","archive","unarchive","locations","addresses","documents"],"additionalProperties":false},"suppliers":{"type":"object","properties":{"create":{"type":"boolean"},"update":{"type":"boolean"},"archive":{"type":"boolean"},"unarchive":{"type":"boolean"},"shipFromLocations":{"type":"object","properties":{"create":{"type":"boolean"},"update":{"type":"boolean"},"archive":{"type":"boolean"},"unarchive":{"type":"boolean"}},"required":["create","update","archive","unarchive"],"additionalProperties":false},"documents":{"type":"object","properties":{"create":{"type":"boolean"}},"required":["create"],"additionalProperties":false}},"required":["create","update","archive","unarchive","shipFromLocations","documents"],"additionalProperties":false},"products":{"type":"object","properties":{"create":{"type":"boolean"},"update":{"type":"boolean"},"archive":{"type":"boolean"},"unarchive":{"type":"boolean"},"packaging":{"type":"object","properties":{"create":{"type":"boolean"}},"required":["create"],"additionalProperties":false},"suppliers":{"type":"object","properties":{"create":{"type":"boolean"},"remove":{"type":"boolean"}},"required":["create","remove"],"additionalProperties":false},"aliases":{"type":"object","properties":{"create":{"type":"boolean"},"update":{"type":"boolean"},"remove":{"type":"boolean"}},"required":["create","update","remove"],"additionalProperties":false},"customerPartNumbers":{"type":"object","properties":{"create":{"type":"boolean"},"update":{"type":"boolean"},"remove":{"type":"boolean"}},"required":["create","update","remove"],"additionalProperties":false},"documents":{"type":"object","properties":{"create":{"type":"boolean"}},"required":["create"],"additionalProperties":false},"sds":{"type":"object","properties":{"update":{"type":"boolean"}},"required":["update"],"additionalProperties":false}},"required":["create","update","archive","unarchive","packaging","suppliers","aliases","customerPartNumbers","documents","sds"],"additionalProperties":false},"productFamilies":{"type":"object","properties":{"create":{"type":"boolean"},"update":{"type":"boolean"},"aliases":{"type":"object","properties":{"create":{"type":"boolean"},"update":{"type":"boolean"},"remove":{"type":"boolean"}},"required":["create","update","remove"],"additionalProperties":false}},"required":["create","update","aliases"],"additionalProperties":false},"costBookEntries":{"type":"object","properties":{"create":{"type":"boolean"},"delete":{"type":"boolean"}},"required":["create","delete"],"additionalProperties":false},"currentCostSources":{"type":"object","properties":{"write":{"type":"boolean"}},"required":["write"],"additionalProperties":false},"priceBookEntries":{"type":"object","properties":{"create":{"type":"boolean"}},"required":["create"],"additionalProperties":false},"purchaseOrders":{"type":"object","properties":{"documents":{"type":"object","properties":{"create":{"type":"boolean"}},"required":["create"],"additionalProperties":false}},"required":["documents"],"additionalProperties":false}},"required":["warehouses","shippingOptions","reorderPoints","tags","notes","opportunities","contacts","customers","suppliers","products","productFamilies","costBookEntries","currentCostSources","priceBookEntries","purchaseOrders"],"additionalProperties":false}},"required":["documentUploads","search","entityResolution","warehouses","shippingOptions","reorderPoints","tags","productDirectory","notes","sentEmails","opportunities","contacts","customers","suppliers","companyReference","products","productFamilies","costBookEntries","currentCostSources","priceBookEntries","orders","purchaseOrders","inventory","reorder","certifications","reports","writeReadiness"],"additionalProperties":false},"provenance":{"type":"object","properties":{"apiKeyId":{"type":"string","format":"uuid"},"purpose":{"type":["string","null"]}},"required":["apiKeyId","purpose"],"additionalProperties":false}},"required":["apiVersion","apiContractVersion","minimumCompatibleContractVersion","org","key","actor","documentation","effectiveCapabilities","provenance"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},"PublicAPIFinancialDocument":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"kind":{"type":"string","enum":["invoice","credit_note","bill","supplier_credit"]},"number":{"type":"string"},"status":{"type":"string"},"counterpartyId":{"type":"string","format":"uuid"},"counterpartyName":{"type":"string"},"counterpartyStatus":{"type":"string","enum":["active","prospect","archived"]},"transactionCurrencyCode":{"type":"string"},"totalAmountCents":{"type":"string","pattern":"^-?\\d+$"},"paidAmountCents":{"type":"string","pattern":"^-?\\d+$"},"openAmountCents":{"type":"string","pattern":"^-?\\d+$"},"baseOpenAmountCents":{"type":"string","pattern":"^-?\\d+$"},"documentDate":{"type":["string","null"],"format":"date-time"},"dueDate":{"type":["string","null"],"format":"date-time"},"paidDate":{"type":["string","null"],"format":"date-time"},"postedAt":{"type":["string","null"],"format":"date-time"},"voidedAt":{"type":["string","null"],"format":"date-time"},"openingBalance":{"type":"boolean"}},"required":["id","kind","number","status","counterpartyId","counterpartyName","counterpartyStatus","transactionCurrencyCode","totalAmountCents","paidAmountCents","openAmountCents","baseOpenAmountCents","documentDate","dueDate","paidDate","postedAt","voidedAt","openingBalance"],"additionalProperties":false},"PublicAPIInvoiceDetail":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"invoiceNo":{"type":"string","minLength":1,"maxLength":300},"externalId":{"type":["string","null"]},"customerId":{"type":"string","format":"uuid"},"counterpartyName":{"type":"string"},"counterpartyStatus":{"type":"string","enum":["active","prospect","archived"]},"paidDate":{"type":["string","null"],"format":"date-time"},"voidedAt":{"type":["string","null"],"format":"date-time"},"termsOfPayment":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"netDays":{"type":"integer"}},"required":["id","name","netDays"],"additionalProperties":false},"openingBalance":{"type":"boolean"},"accountingCutoverDay":{"type":["string","null"]},"appliedPayments":{"type":["array","null"],"items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"paymentNo":{"type":"string"},"routeId":{"type":["string","null"],"format":"uuid"},"paidAt":{"type":"string","format":"date-time"},"transactionCurrencyCode":{"type":"string","description":"Currency of the cash amount."},"documentCurrencyCode":{"type":"string","description":"Currency of the document discount or write-off amount."},"cashAmountCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"creditAmountCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"discountOrWriteOffAmountCents":{"type":"string","pattern":"^-?\\d+$"},"cashUnavailableReason":{"type":["string","null"],"enum":["legacy_mixed_cash_and_credit","mixed_cash_and_credit_attribution_unrecorded"]}},"required":["id","paymentNo","routeId","paidAt","transactionCurrencyCode","documentCurrencyCode","cashAmountCents","creditAmountCents","discountOrWriteOffAmountCents","cashUnavailableReason"],"additionalProperties":false}},"appliedPaymentsComplete":{"type":"boolean"},"status":{"type":"string","enum":["DRAFT","POSTED","PARTIALLY_PAID","PAID","VOID"]},"submittedDate":{"type":["string","null"],"format":"date-time"},"dueDate":{"type":["string","null"],"format":"date-time"},"postedAt":{"type":["string","null"],"format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["user"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["system"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string","enum":["System User"]}},"required":["type","id","displayName"],"additionalProperties":false}]},"money":{"type":"object","properties":{"totalAmountCents":{"type":"string","pattern":"^-?\\d+$"},"paidAmountCents":{"type":"string","pattern":"^-?\\d+$"},"openAmountCents":{"type":"string","pattern":"^-?\\d+$"},"resolvedCurrencyCode":{"type":"string","pattern":"^[A-Z]{3}$"}},"required":["totalAmountCents","paidAmountCents","openAmountCents","resolvedCurrencyCode"],"additionalProperties":false}},"required":["id","invoiceNo","externalId","customerId","counterpartyName","counterpartyStatus","paidDate","voidedAt","termsOfPayment","openingBalance","accountingCutoverDay","appliedPayments","appliedPaymentsComplete","status","submittedDate","dueDate","postedAt","updatedAt","createdAt","createdBy","money"],"additionalProperties":false},"PublicAPIBillDetail":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"billNo":{"type":"string","minLength":1,"maxLength":300},"externalId":{"type":["string","null"]},"supplierId":{"type":"string","format":"uuid"},"counterpartyName":{"type":"string"},"counterpartyStatus":{"type":"string","enum":["active","prospect","archived"]},"paidDate":{"type":["string","null"],"format":"date-time"},"voidedAt":{"type":["string","null"],"format":"date-time"},"termsOfPayment":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"netDays":{"type":"integer"}},"required":["id","name","netDays"],"additionalProperties":false},"openingBalance":{"type":"boolean"},"accountingCutoverDay":{"type":["string","null"]},"appliedPayments":{"type":["array","null"],"items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"paymentNo":{"type":"string"},"routeId":{"type":["string","null"],"format":"uuid"},"paidAt":{"type":"string","format":"date-time"},"transactionCurrencyCode":{"type":"string","description":"Currency of the cash amount."},"documentCurrencyCode":{"type":"string","description":"Currency of the document discount or write-off amount."},"cashAmountCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"creditAmountCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"discountOrWriteOffAmountCents":{"type":"string","pattern":"^-?\\d+$"},"cashUnavailableReason":{"type":["string","null"],"enum":["legacy_mixed_cash_and_credit","mixed_cash_and_credit_attribution_unrecorded"]}},"required":["id","paymentNo","routeId","paidAt","transactionCurrencyCode","documentCurrencyCode","cashAmountCents","creditAmountCents","discountOrWriteOffAmountCents","cashUnavailableReason"],"additionalProperties":false}},"appliedPaymentsComplete":{"type":"boolean"},"status":{"type":"string","enum":["DRAFT","POSTED","PARTIALLY_PAID","PAID","VOID"]},"issuedDate":{"type":"string","format":"date-time"},"dueDate":{"type":"string","format":"date-time"},"postedAt":{"type":["string","null"],"format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["user"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["system"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string","enum":["System User"]}},"required":["type","id","displayName"],"additionalProperties":false}]},"money":{"type":"object","properties":{"itemsAmountCents":{"type":"string","pattern":"^-?\\d+$"},"paidAmountCents":{"type":"string","pattern":"^-?\\d+$"},"openAmountCents":{"type":"string","pattern":"^-?\\d+$"},"resolvedCurrencyCode":{"type":"string","pattern":"^[A-Z]{3}$"}},"required":["itemsAmountCents","paidAmountCents","openAmountCents","resolvedCurrencyCode"],"additionalProperties":false}},"required":["id","billNo","externalId","supplierId","counterpartyName","counterpartyStatus","paidDate","voidedAt","termsOfPayment","openingBalance","accountingCutoverDay","appliedPayments","appliedPaymentsComplete","status","issuedDate","dueDate","postedAt","updatedAt","createdAt","createdBy","money"],"additionalProperties":false},"PublicAPICustomerPayment":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"paymentNo":{"type":"string"},"counterpartyId":{"type":"string","format":"uuid"},"counterpartyName":{"type":"string"},"counterpartyStatus":{"type":"string","enum":["active","prospect","archived"]},"paidAt":{"type":"string","format":"date-time"},"transactionCurrencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"amountCents":{"type":"string"},"baseAmountCents":{"type":"string"},"method":{"type":"string"},"remainderTreatment":{"type":"string"},"keptOnAccountCents":{"type":"string"},"writtenOffCents":{"type":"string"},"depositId":{"type":["string","null"],"format":"uuid"},"depositNo":{"type":["string","null"]},"depositDate":{"type":["string","null"],"format":"date-time"},"depositAmountCents":{"type":["string","null"]},"depositCurrencyCode":{"type":["string","null"],"pattern":"^[A-Z]{3}$"},"depositPaymentCount":{"type":"integer","minimum":0},"matchedOn":{"type":"string","enum":["payment","deposit_total"]},"appliedDocuments":{"type":["array","null"],"items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"number":{"type":"string"},"transactionCurrencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"amountCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"paymentAmountCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"paymentCurrencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"documentAmountUnavailableReason":{"type":["string","null"],"enum":["legacy_cross_currency_document_amount"]},"discountOrWriteOffAmountCents":{"type":"string","pattern":"^-?\\d+$"},"unavailableReason":{"type":["string","null"],"enum":["legacy_mixed_cash_and_credit","mixed_cash_and_credit_attribution_unrecorded"]}},"required":["id","number","transactionCurrencyCode","amountCents","paymentAmountCents","paymentCurrencyCode","documentAmountUnavailableReason","discountOrWriteOffAmountCents","unavailableReason"],"additionalProperties":false},"maxItems":501},"creditsUsed":{"type":["array","null"],"items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"number":{"type":"string"},"transactionCurrencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"amountCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"unavailableReason":{"type":["string","null"],"enum":["legacy_cross_currency_document_amount"]}},"required":["id","number","transactionCurrencyCode","amountCents","unavailableReason"],"additionalProperties":false},"maxItems":501},"appliedDocumentCount":{"type":["integer","null"],"minimum":0},"preGoLive":{"type":"boolean"},"appliedDocumentsComplete":{"type":["boolean","null"]},"creditsUsedComplete":{"type":["boolean","null"]}},"required":["id","paymentNo","counterpartyId","counterpartyName","counterpartyStatus","paidAt","transactionCurrencyCode","amountCents","baseAmountCents","method","remainderTreatment","keptOnAccountCents","writtenOffCents","depositId","depositNo","depositDate","depositAmountCents","depositCurrencyCode","depositPaymentCount","matchedOn","appliedDocuments","creditsUsed","appliedDocumentCount","preGoLive","appliedDocumentsComplete","creditsUsedComplete"],"additionalProperties":false},"PublicAPISupplierPayment":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"paymentNo":{"type":"string"},"counterpartyId":{"type":"string","format":"uuid"},"counterpartyName":{"type":"string"},"counterpartyStatus":{"type":"string","enum":["active","archived"]},"paidAt":{"type":"string","format":"date-time"},"transactionCurrencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"amountCents":{"type":"string"},"baseAmountCents":{"type":"string"},"discountAmountCents":{"type":"string"},"batchId":{"type":"string","format":"uuid"},"batchNo":{"type":"string"},"batchAmountCents":{"type":"string"},"batchCurrencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"bankAccountName":{"type":"string"},"paymentFile":{"type":["string","null"],"enum":["ach","check"]},"matchedOn":{"type":"string","enum":["payment","batch_total"]},"appliedDocuments":{"type":["array","null"],"items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"number":{"type":"string"},"transactionCurrencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"amountCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"paymentAmountCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"paymentCurrencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"documentAmountUnavailableReason":{"type":["string","null"],"enum":["legacy_cross_currency_document_amount"]},"discountOrWriteOffAmountCents":{"type":"string","pattern":"^-?\\d+$"},"unavailableReason":{"type":["string","null"],"enum":["legacy_mixed_cash_and_credit","mixed_cash_and_credit_attribution_unrecorded"]}},"required":["id","number","transactionCurrencyCode","amountCents","paymentAmountCents","paymentCurrencyCode","documentAmountUnavailableReason","discountOrWriteOffAmountCents","unavailableReason"],"additionalProperties":false},"maxItems":501},"creditsUsed":{"type":["array","null"],"items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"number":{"type":"string"},"transactionCurrencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"amountCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"unavailableReason":{"type":["string","null"],"enum":["legacy_cross_currency_document_amount"]}},"required":["id","number","transactionCurrencyCode","amountCents","unavailableReason"],"additionalProperties":false},"maxItems":501},"appliedDocumentCount":{"type":["integer","null"],"minimum":0},"preGoLive":{"type":"boolean"},"appliedDocumentsComplete":{"type":["boolean","null"]},"creditsUsedComplete":{"type":["boolean","null"]}},"required":["id","paymentNo","counterpartyId","counterpartyName","counterpartyStatus","paidAt","transactionCurrencyCode","amountCents","baseAmountCents","discountAmountCents","batchId","batchNo","batchAmountCents","batchCurrencyCode","bankAccountName","paymentFile","matchedOn","appliedDocuments","creditsUsed","appliedDocumentCount","preGoLive","appliedDocumentsComplete","creditsUsedComplete"],"additionalProperties":false},"PublicAPILotsResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"createdBy":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["user"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["system"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string","enum":["System User"]}},"required":["type","id","displayName"],"additionalProperties":false}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"lotNumber":{"type":"string"},"placeholder":{"type":"boolean"},"catalogPackaging":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","minLength":1}},"required":["id","name"],"additionalProperties":false},"warehouse":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","minLength":1},"archived":{"type":"boolean"},"directShip":{"type":"boolean"}},"required":["id","name","archived","directShip"],"additionalProperties":false},"supplier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","minLength":1}},"required":["id","name"],"additionalProperties":false},"lotState":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","minLength":1},"code":{"type":["string","null"],"enum":["AVAILABLE","QUARANTINED"]}},"required":["id","name","code"],"additionalProperties":false},"quarantined":{"type":"boolean"},"quantityBasis":{"type":"object","properties":{"type":{"type":"string","enum":["package_count","base_uom"]},"unitOfMeasure":{"type":"string","minLength":1}},"required":["type","unitOfMeasure"],"additionalProperties":false},"quantities":{"type":"object","properties":{"qtyOnOrder":{"type":"string","pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d*[1-9])?$"},"qtyOnHand":{"type":"string","pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d*[1-9])?$"},"qtyAllocated":{"type":"string","pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d*[1-9])?$"},"qtyAvailable":{"type":"string","pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d*[1-9])?$"}},"required":["qtyOnOrder","qtyOnHand","qtyAllocated","qtyAvailable"],"additionalProperties":false},"manufactureDate":{"type":["string","null"],"format":"date-time"},"expirationDate":{"type":["string","null"],"format":"date-time"},"ageEvidence":{"type":"object","properties":{"recordedAddedAt":{"type":["string","null"],"format":"date-time"},"recordedAddedOn":{"type":["string","null"],"pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"cutoverEvidence":{"type":"string","enum":["none","org_day_equals_cutover","utc_midnight_date_equals_cutover","both"]},"ageUnavailableReason":{"type":"string","enum":["none","no_on_hand","pending_only","virtual_or_inconsistent","uncertifiable"]}},"required":["recordedAddedAt","recordedAddedOn","cutoverEvidence","ageUnavailableReason"],"additionalProperties":false},"limitations":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["unexplained_on_order","unexplained_allocated"]},"quantity":{"type":"string","enum":["qtyOnOrder","qtyAllocated"]},"stored":{"type":"string","pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d*[1-9])?$"},"explained":{"type":"string","pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d*[1-9])?$"}},"required":["code","quantity","stored","explained"],"additionalProperties":false}},"coaAttached":{"type":"boolean"},"type":{"type":"string","enum":["lot"]},"product":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"code":{"type":"string"},"archived":{"type":"boolean"}},"required":["id","code","archived"],"additionalProperties":false}},"required":["createdBy","createdAt","id","lotNumber","placeholder","catalogPackaging","warehouse","lotState","quarantined","quantityBasis","quantities","manufactureDate","expirationDate","ageEvidence","limitations","coaAttached","type","product"],"additionalProperties":false}},"meta":{"type":"object","properties":{"populationCount":{"type":"integer","minimum":0},"returnedRows":{"type":"integer","minimum":0},"hasMore":{"type":"boolean"},"recordedDateMatchLotCount":{"type":"integer","minimum":0},"unresolvedAgeLotCount":{"type":"integer","minimum":0},"nextCursor":{"type":["string","null"]},"ordering":{"type":"string","enum":["product_id_asc_warehouse_id_asc_lot_number_asc_id_asc"]},"observedAt":{"type":"string","format":"date-time"},"currentState":{"type":"boolean","enum":[true]},"snapshotIsolatedAcrossRequests":{"type":"boolean","enum":[false]},"requestId":{"type":"string"}},"required":["populationCount","returnedRows","hasMore","recordedDateMatchLotCount","unresolvedAgeLotCount","nextCursor","ordering","observedAt","currentState","snapshotIsolatedAcrossRequests","requestId"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false},"PublicAPILotDetailResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"createdBy":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["user"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["system"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string","enum":["System User"]}},"required":["type","id","displayName"],"additionalProperties":false}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"lotNumber":{"type":"string"},"placeholder":{"type":"boolean"},"catalogPackaging":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","minLength":1}},"required":["id","name"],"additionalProperties":false},"warehouse":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","minLength":1},"archived":{"type":"boolean"},"directShip":{"type":"boolean"}},"required":["id","name","archived","directShip"],"additionalProperties":false},"supplier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","minLength":1}},"required":["id","name"],"additionalProperties":false},"lotState":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","minLength":1},"code":{"type":["string","null"],"enum":["AVAILABLE","QUARANTINED"]}},"required":["id","name","code"],"additionalProperties":false},"quarantined":{"type":"boolean"},"quantityBasis":{"type":"object","properties":{"type":{"type":"string","enum":["package_count","base_uom"]},"unitOfMeasure":{"type":"string","minLength":1}},"required":["type","unitOfMeasure"],"additionalProperties":false},"quantities":{"type":"object","properties":{"qtyOnOrder":{"type":"string","pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d*[1-9])?$"},"qtyOnHand":{"type":"string","pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d*[1-9])?$"},"qtyAllocated":{"type":"string","pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d*[1-9])?$"},"qtyAvailable":{"type":"string","pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d*[1-9])?$"}},"required":["qtyOnOrder","qtyOnHand","qtyAllocated","qtyAvailable"],"additionalProperties":false},"manufactureDate":{"type":["string","null"],"format":"date-time"},"expirationDate":{"type":["string","null"],"format":"date-time"},"ageEvidence":{"type":"object","properties":{"recordedAddedAt":{"type":["string","null"],"format":"date-time"},"recordedAddedOn":{"type":["string","null"],"pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"cutoverEvidence":{"type":"string","enum":["none","org_day_equals_cutover","utc_midnight_date_equals_cutover","both"]},"ageUnavailableReason":{"type":"string","enum":["none","no_on_hand","pending_only","virtual_or_inconsistent","uncertifiable"]}},"required":["recordedAddedAt","recordedAddedOn","cutoverEvidence","ageUnavailableReason"],"additionalProperties":false},"limitations":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["unexplained_on_order","unexplained_allocated"]},"quantity":{"type":"string","enum":["qtyOnOrder","qtyAllocated"]},"stored":{"type":"string","pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d*[1-9])?$"},"explained":{"type":"string","pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d*[1-9])?$"}},"required":["code","quantity","stored","explained"],"additionalProperties":false}},"coaAttached":{"type":"boolean"},"type":{"type":"string","enum":["lot"]},"product":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"code":{"type":"string"},"archived":{"type":"boolean"}},"required":["id","code","archived"],"additionalProperties":false},"remainingPhysicalPackagingId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string","enum":["MIXED"]},{"type":"string","enum":["UNKNOWN"]}]},"remainingPhysicalLayers":{"type":"array","items":{"type":"object","properties":{"receiptId":{"type":"string","format":"uuid"},"recordedAddedAt":{"type":"string","format":"date-time"},"recordedAddedOn":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"originalQuantity":{"type":"string","pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d*[1-9])?$"},"remainingQuantity":{"type":"string","pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d*[1-9])?$"},"productPackagingId":{"type":["string","null"],"format":"uuid"},"capacityUOM":{"type":["string","null"],"pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d*[1-9])?$"},"sourceKind":{"type":"string","enum":["unclassified","purchase_order","production"]}},"required":["receiptId","recordedAddedAt","recordedAddedOn","originalQuantity","remainingQuantity","productPackagingId","capacityUOM","sourceKind"],"additionalProperties":false}},"layerCoverage":{"type":"object","properties":{"remainingLayerCount":{"type":"integer","minimum":0},"returnedLayers":{"type":"integer","minimum":0},"truncated":{"type":"boolean"}},"required":["remainingLayerCount","returnedLayers","truncated"],"additionalProperties":false}},"required":["createdBy","createdAt","id","lotNumber","placeholder","catalogPackaging","warehouse","lotState","quarantined","quantityBasis","quantities","manufactureDate","expirationDate","ageEvidence","limitations","coaAttached","type","product","remainingPhysicalPackagingId","remainingPhysicalLayers","layerCoverage"],"additionalProperties":false},"meta":{"type":"object","properties":{"observedAt":{"type":"string","format":"date-time"},"currentState":{"type":"boolean","enum":[true]},"snapshotIsolatedAcrossRequests":{"type":"boolean","enum":[false]},"requestId":{"type":"string"}},"required":["observedAt","currentState","snapshotIsolatedAcrossRequests","requestId"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false},"PublicAPICertificationTypesResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"title":{"type":"string","minLength":1},"description":{"type":"string"},"enabled":{"type":"boolean"},"documentationRequired":{"type":"boolean"},"expiryNoticeDaysBefore":{"type":["integer","null"]},"subjectType":{"type":"string","enum":["supplier","customer","product","customer_address","warehouse","supplier_combination"]},"type":{"type":"string","enum":["certification_type"]}},"required":["id","title","description","enabled","documentationRequired","expiryNoticeDaysBefore","subjectType","type"],"additionalProperties":false}},"meta":{"type":"object","properties":{"capabilityKey":{"type":"string","enum":["list_certification_types"]},"returnedRecords":{"type":"integer","minimum":0},"populationCount":{"type":["integer","null"],"minimum":0},"complete":{"type":"boolean"},"hasMore":{"type":"boolean"},"nextCursor":{"type":["string","null"]},"ordering":{"type":"string","enum":["title_id","valid_to_nulls_last_record_id","subject_type_subject_id_ship_from_product"]},"currentState":{"type":"boolean","enum":[true]},"snapshotIsolatedAcrossRequests":{"type":"boolean","enum":[false]},"requestId":{"type":"string"},"evaluatedAt":{"type":"string","format":"date-time"},"coverage":{"type":"object","properties":{"evaluatedAt":{"type":"string","format":"date-time"},"organizationId":{"type":"string","format":"uuid"},"organizationScoped":{"type":"boolean","enum":[true]},"currentState":{"type":"boolean","enum":[true]},"snapshotIsolatedAcrossRequests":{"type":"boolean","enum":[false]},"placeholderExcluded":{"type":"boolean"},"archivedExcluded":{"type":"boolean"},"searchedFields":{"type":"array","items":{"type":"string","minLength":1}},"requestedLanes":{"type":"array","items":{"type":"string","enum":["supplier","customer","product","customer_address","warehouse","supplier_combination"]}},"lanes":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"subjectType":{"type":"string","enum":["supplier","customer","product","customer_address","warehouse","supplier_combination"]},"status":{"type":"string","enum":["executed"]},"populationCount":{"type":["integer","null"],"minimum":0}},"required":["subjectType","status","populationCount"],"additionalProperties":false},{"type":"object","properties":{"subjectType":{"type":"string","enum":["supplier","customer","product","customer_address","warehouse","supplier_combination"]},"status":{"type":"string","enum":["denied"]}},"required":["subjectType","status"],"additionalProperties":false},{"type":"object","properties":{"subjectType":{"type":"string","enum":["supplier","customer","product","customer_address","warehouse","supplier_combination"]},"status":{"type":"string","enum":["unsupported"]}},"required":["subjectType","status"],"additionalProperties":false}]}},"appliedFilters":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","enum":["types"]},"subjectType":{"type":["string","null"],"enum":["supplier","customer","product","customer_address","warehouse","supplier_combination"]},"includeDisabled":{"type":"boolean"}},"required":["kind","subjectType","includeDisabled"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","enum":["records"]},"typeId":{"type":["string","null"],"format":"uuid"},"typeQuery":{"type":["string","null"],"minLength":1,"maxLength":120},"evidenceFileNameQuery":{"type":["string","null"],"minLength":1,"maxLength":240},"subjectTypes":{"type":["array","null"],"items":{"type":"string","enum":["supplier","customer","product","customer_address","warehouse","supplier_combination"]},"minItems":1,"maxItems":6},"subjectId":{"type":["string","null"],"format":"uuid"},"recordedStatuses":{"type":["array","null"],"items":{"type":"string","enum":["PENDING","ACTIVE","EXPIRED"]},"minItems":1,"maxItems":3},"effectiveStates":{"type":["array","null"],"items":{"type":"string","enum":["pending","current","expired","incomplete"]},"minItems":1,"maxItems":4},"expiresAtOrAfter":{"type":["string","null"],"format":"date-time"},"expiresAtOrBefore":{"type":["string","null"],"format":"date-time"},"evidenceRecordedState":{"type":["string","null"],"enum":["recorded","not_recorded","invalid_metadata"]},"includePlaceholders":{"type":"boolean"},"includeArchived":{"type":"boolean"},"renewalStates":{"type":["array","null"],"items":{"type":"string","enum":["current","expiring","expired","renewed","not_tracked"]},"minItems":1,"maxItems":5}},"required":["kind","typeId","typeQuery","evidenceFileNameQuery","subjectTypes","subjectId","recordedStatuses","effectiveStates","expiresAtOrAfter","expiresAtOrBefore","evidenceRecordedState","includePlaceholders","includeArchived","renewalStates"],"additionalProperties":false}]},"totalRecords":{"type":["integer","null"],"minimum":0},"returnedRecords":{"type":"integer","minimum":0}},"required":["evaluatedAt","organizationId","organizationScoped","currentState","snapshotIsolatedAcrossRequests","placeholderExcluded","archivedExcluded","searchedFields","requestedLanes","lanes","appliedFilters","totalRecords","returnedRecords"],"additionalProperties":false},"capabilityVersion":{"type":"string","enum":["1.1.0"]}},"required":["capabilityKey","returnedRecords","populationCount","complete","hasMore","nextCursor","ordering","currentState","snapshotIsolatedAcrossRequests","requestId","evaluatedAt","coverage","capabilityVersion"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false},"PublicAPICertificationRecordsResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"recordId":{"type":"string","format":"uuid"},"resourceKind":{"type":"string","enum":["stored_certification_record"]},"type":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"title":{"type":"string","minLength":1},"description":{"type":"string"},"enabled":{"type":"boolean"},"documentationRequired":{"type":"boolean"},"expiryNoticeDaysBefore":{"type":["integer","null"]},"subjectType":{"type":"string","enum":["supplier","customer","product","customer_address","warehouse","supplier_combination"]}},"required":["id","title","description","enabled","documentationRequired","expiryNoticeDaysBefore","subjectType"],"additionalProperties":false},"subject":{"type":"object","properties":{"subjectType":{"type":"string","enum":["supplier","customer","product","customer_address","warehouse","supplier_combination"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string","minLength":1},"externalId":{"type":["string","null"]},"archived":{"type":"boolean"},"customerId":{"type":["string","null"],"format":"uuid"},"locationId":{"type":["string","null"],"format":"uuid"},"addressId":{"type":["string","null"],"format":"uuid"},"combination":{"type":["object","null"],"properties":{"shipFromLocationId":{"type":"string","format":"uuid"},"shipFromLocationName":{"type":"string","minLength":1},"productId":{"type":"string","format":"uuid"},"productDisplayName":{"type":"string","minLength":1}},"required":["shipFromLocationId","shipFromLocationName","productId","productDisplayName"],"additionalProperties":false}},"required":["subjectType","id","displayName","externalId","archived","customerId","locationId","addressId","combination"],"additionalProperties":false},"recordedStatus":{"type":"string","enum":["PENDING","ACTIVE","EXPIRED"]},"effectiveState":{"type":"string","enum":["pending","current","expired","incomplete"]},"renewalState":{"type":"string","enum":["current","expiring","expired","renewed","not_tracked"]},"daysLeft":{"type":["integer","null"],"minimum":0},"validFrom":{"type":["string","null"],"format":"date-time"},"validTo":{"type":["string","null"],"format":"date-time"},"recordCompleteness":{"type":"string","enum":["populated","placeholder"]},"evidence":{"type":"object","properties":{"recordedState":{"type":"string","enum":["recorded","not_recorded","invalid_metadata"]},"fileName":{"type":["string","null"],"minLength":1}},"required":["recordedState","fileName"],"additionalProperties":false},"matchBasis":{"type":"array","items":{"type":"string","enum":["type_title","type_description","evidence_file_name","unfiltered"]},"minItems":1},"searchedFields":{"type":"array","items":{"type":"string","minLength":1}},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["user"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["system"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string","enum":["System User"]}},"required":["type","id","displayName"],"additionalProperties":false}]},"updatedAt":{"type":"string","format":"date-time"}},"required":["recordId","resourceKind","type","subject","recordedStatus","effectiveState","renewalState","daysLeft","validFrom","validTo","recordCompleteness","evidence","matchBasis","searchedFields","createdAt","createdBy","updatedAt"],"additionalProperties":false}},"meta":{"type":"object","properties":{"capabilityKey":{"type":"string","enum":["find_certification_records"]},"returnedRecords":{"type":"integer","minimum":0},"populationCount":{"type":["integer","null"],"minimum":0},"complete":{"type":"boolean"},"hasMore":{"type":"boolean"},"nextCursor":{"type":["string","null"]},"ordering":{"type":"string","enum":["title_id","valid_to_nulls_last_record_id","subject_type_subject_id_ship_from_product"]},"currentState":{"type":"boolean","enum":[true]},"snapshotIsolatedAcrossRequests":{"type":"boolean","enum":[false]},"requestId":{"type":"string"},"evaluatedAt":{"type":"string","format":"date-time"},"coverage":{"type":"object","properties":{"evaluatedAt":{"type":"string","format":"date-time"},"organizationId":{"type":"string","format":"uuid"},"organizationScoped":{"type":"boolean","enum":[true]},"currentState":{"type":"boolean","enum":[true]},"snapshotIsolatedAcrossRequests":{"type":"boolean","enum":[false]},"placeholderExcluded":{"type":"boolean"},"archivedExcluded":{"type":"boolean"},"searchedFields":{"type":"array","items":{"type":"string","minLength":1}},"requestedLanes":{"type":"array","items":{"type":"string","enum":["supplier","customer","product","customer_address","warehouse","supplier_combination"]}},"lanes":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"subjectType":{"type":"string","enum":["supplier","customer","product","customer_address","warehouse","supplier_combination"]},"status":{"type":"string","enum":["executed"]},"populationCount":{"type":["integer","null"],"minimum":0}},"required":["subjectType","status","populationCount"],"additionalProperties":false},{"type":"object","properties":{"subjectType":{"type":"string","enum":["supplier","customer","product","customer_address","warehouse","supplier_combination"]},"status":{"type":"string","enum":["denied"]}},"required":["subjectType","status"],"additionalProperties":false},{"type":"object","properties":{"subjectType":{"type":"string","enum":["supplier","customer","product","customer_address","warehouse","supplier_combination"]},"status":{"type":"string","enum":["unsupported"]}},"required":["subjectType","status"],"additionalProperties":false}]}},"appliedFilters":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","enum":["types"]},"subjectType":{"type":["string","null"],"enum":["supplier","customer","product","customer_address","warehouse","supplier_combination"]},"includeDisabled":{"type":"boolean"}},"required":["kind","subjectType","includeDisabled"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","enum":["records"]},"typeId":{"type":["string","null"],"format":"uuid"},"typeQuery":{"type":["string","null"],"minLength":1,"maxLength":120},"evidenceFileNameQuery":{"type":["string","null"],"minLength":1,"maxLength":240},"subjectTypes":{"type":["array","null"],"items":{"type":"string","enum":["supplier","customer","product","customer_address","warehouse","supplier_combination"]},"minItems":1,"maxItems":6},"subjectId":{"type":["string","null"],"format":"uuid"},"recordedStatuses":{"type":["array","null"],"items":{"type":"string","enum":["PENDING","ACTIVE","EXPIRED"]},"minItems":1,"maxItems":3},"effectiveStates":{"type":["array","null"],"items":{"type":"string","enum":["pending","current","expired","incomplete"]},"minItems":1,"maxItems":4},"expiresAtOrAfter":{"type":["string","null"],"format":"date-time"},"expiresAtOrBefore":{"type":["string","null"],"format":"date-time"},"evidenceRecordedState":{"type":["string","null"],"enum":["recorded","not_recorded","invalid_metadata"]},"includePlaceholders":{"type":"boolean"},"includeArchived":{"type":"boolean"},"renewalStates":{"type":["array","null"],"items":{"type":"string","enum":["current","expiring","expired","renewed","not_tracked"]},"minItems":1,"maxItems":5}},"required":["kind","typeId","typeQuery","evidenceFileNameQuery","subjectTypes","subjectId","recordedStatuses","effectiveStates","expiresAtOrAfter","expiresAtOrBefore","evidenceRecordedState","includePlaceholders","includeArchived","renewalStates"],"additionalProperties":false}]},"totalRecords":{"type":["integer","null"],"minimum":0},"returnedRecords":{"type":"integer","minimum":0}},"required":["evaluatedAt","organizationId","organizationScoped","currentState","snapshotIsolatedAcrossRequests","placeholderExcluded","archivedExcluded","searchedFields","requestedLanes","lanes","appliedFilters","totalRecords","returnedRecords"],"additionalProperties":false},"capabilityVersion":{"type":"string","enum":["1.2.0"]}},"required":["capabilityKey","returnedRecords","populationCount","complete","hasMore","nextCursor","ordering","currentState","snapshotIsolatedAcrossRequests","requestId","evaluatedAt","coverage","capabilityVersion"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false},"PublicAPICertificationSubjectsResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"subjectType":{"type":"string","enum":["supplier","customer","product","customer_address","warehouse","supplier_combination"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string","minLength":1},"externalId":{"type":["string","null"]},"archived":{"type":"boolean"},"customerId":{"type":["string","null"],"format":"uuid"},"locationId":{"type":["string","null"],"format":"uuid"},"addressId":{"type":["string","null"],"format":"uuid"},"combination":{"type":["object","null"],"properties":{"shipFromLocationId":{"type":"string","format":"uuid"},"shipFromLocationName":{"type":"string","minLength":1},"productId":{"type":"string","format":"uuid"},"productDisplayName":{"type":"string","minLength":1}},"required":["shipFromLocationId","shipFromLocationName","productId","productDisplayName"],"additionalProperties":false},"matchingRecordCount":{"type":"integer","exclusiveMinimum":0},"currentMatchingRecordCount":{"type":"integer","minimum":0},"latestCurrentValidTo":{"type":["string","null"],"format":"date-time"},"type":{"type":"string","enum":["certification_subject"]}},"required":["subjectType","id","displayName","externalId","archived","customerId","locationId","addressId","combination","matchingRecordCount","currentMatchingRecordCount","latestCurrentValidTo","type"],"additionalProperties":false}},"meta":{"type":"object","properties":{"capabilityKey":{"type":"string","enum":["find_certification_subjects"]},"returnedRecords":{"type":"integer","minimum":0},"populationCount":{"type":["integer","null"],"minimum":0},"complete":{"type":"boolean"},"hasMore":{"type":"boolean"},"nextCursor":{"type":["string","null"]},"ordering":{"type":"string","enum":["title_id","valid_to_nulls_last_record_id","subject_type_subject_id_ship_from_product"]},"currentState":{"type":"boolean","enum":[true]},"snapshotIsolatedAcrossRequests":{"type":"boolean","enum":[false]},"requestId":{"type":"string"},"evaluatedAt":{"type":"string","format":"date-time"},"coverage":{"type":"object","properties":{"evaluatedAt":{"type":"string","format":"date-time"},"organizationId":{"type":"string","format":"uuid"},"organizationScoped":{"type":"boolean","enum":[true]},"currentState":{"type":"boolean","enum":[true]},"snapshotIsolatedAcrossRequests":{"type":"boolean","enum":[false]},"placeholderExcluded":{"type":"boolean"},"archivedExcluded":{"type":"boolean"},"searchedFields":{"type":"array","items":{"type":"string","minLength":1}},"requestedLanes":{"type":"array","items":{"type":"string","enum":["supplier","customer","product","customer_address","warehouse","supplier_combination"]}},"lanes":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"subjectType":{"type":"string","enum":["supplier","customer","product","customer_address","warehouse","supplier_combination"]},"status":{"type":"string","enum":["executed"]},"populationCount":{"type":["integer","null"],"minimum":0}},"required":["subjectType","status","populationCount"],"additionalProperties":false},{"type":"object","properties":{"subjectType":{"type":"string","enum":["supplier","customer","product","customer_address","warehouse","supplier_combination"]},"status":{"type":"string","enum":["denied"]}},"required":["subjectType","status"],"additionalProperties":false},{"type":"object","properties":{"subjectType":{"type":"string","enum":["supplier","customer","product","customer_address","warehouse","supplier_combination"]},"status":{"type":"string","enum":["unsupported"]}},"required":["subjectType","status"],"additionalProperties":false}]}},"appliedFilters":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","enum":["types"]},"subjectType":{"type":["string","null"],"enum":["supplier","customer","product","customer_address","warehouse","supplier_combination"]},"includeDisabled":{"type":"boolean"}},"required":["kind","subjectType","includeDisabled"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","enum":["records"]},"typeId":{"type":["string","null"],"format":"uuid"},"typeQuery":{"type":["string","null"],"minLength":1,"maxLength":120},"evidenceFileNameQuery":{"type":["string","null"],"minLength":1,"maxLength":240},"subjectTypes":{"type":["array","null"],"items":{"type":"string","enum":["supplier","customer","product","customer_address","warehouse","supplier_combination"]},"minItems":1,"maxItems":6},"subjectId":{"type":["string","null"],"format":"uuid"},"recordedStatuses":{"type":["array","null"],"items":{"type":"string","enum":["PENDING","ACTIVE","EXPIRED"]},"minItems":1,"maxItems":3},"effectiveStates":{"type":["array","null"],"items":{"type":"string","enum":["pending","current","expired","incomplete"]},"minItems":1,"maxItems":4},"expiresAtOrAfter":{"type":["string","null"],"format":"date-time"},"expiresAtOrBefore":{"type":["string","null"],"format":"date-time"},"evidenceRecordedState":{"type":["string","null"],"enum":["recorded","not_recorded","invalid_metadata"]},"includePlaceholders":{"type":"boolean"},"includeArchived":{"type":"boolean"},"renewalStates":{"type":["array","null"],"items":{"type":"string","enum":["current","expiring","expired","renewed","not_tracked"]},"minItems":1,"maxItems":5}},"required":["kind","typeId","typeQuery","evidenceFileNameQuery","subjectTypes","subjectId","recordedStatuses","effectiveStates","expiresAtOrAfter","expiresAtOrBefore","evidenceRecordedState","includePlaceholders","includeArchived","renewalStates"],"additionalProperties":false}]},"totalRecords":{"type":["integer","null"],"minimum":0},"returnedRecords":{"type":"integer","minimum":0}},"required":["evaluatedAt","organizationId","organizationScoped","currentState","snapshotIsolatedAcrossRequests","placeholderExcluded","archivedExcluded","searchedFields","requestedLanes","lanes","appliedFilters","totalRecords","returnedRecords"],"additionalProperties":false},"capabilityVersion":{"type":"string","enum":["1.1.0"]}},"required":["capabilityKey","returnedRecords","populationCount","complete","hasMore","nextCursor","ordering","currentState","snapshotIsolatedAcrossRequests","requestId","evaluatedAt","coverage","capabilityVersion"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false},"PublicAPICertificationRecordResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"recordId":{"type":"string","format":"uuid"},"resourceKind":{"type":"string","enum":["stored_certification_record"]},"type":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"title":{"type":"string","minLength":1},"description":{"type":"string"},"enabled":{"type":"boolean"},"documentationRequired":{"type":"boolean"},"expiryNoticeDaysBefore":{"type":["integer","null"]},"subjectType":{"type":"string","enum":["supplier","customer","product","customer_address","warehouse","supplier_combination"]}},"required":["id","title","description","enabled","documentationRequired","expiryNoticeDaysBefore","subjectType"],"additionalProperties":false},"subject":{"type":"object","properties":{"subjectType":{"type":"string","enum":["supplier","customer","product","customer_address","warehouse","supplier_combination"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string","minLength":1},"externalId":{"type":["string","null"]},"archived":{"type":"boolean"},"customerId":{"type":["string","null"],"format":"uuid"},"locationId":{"type":["string","null"],"format":"uuid"},"addressId":{"type":["string","null"],"format":"uuid"},"combination":{"type":["object","null"],"properties":{"shipFromLocationId":{"type":"string","format":"uuid"},"shipFromLocationName":{"type":"string","minLength":1},"productId":{"type":"string","format":"uuid"},"productDisplayName":{"type":"string","minLength":1}},"required":["shipFromLocationId","shipFromLocationName","productId","productDisplayName"],"additionalProperties":false}},"required":["subjectType","id","displayName","externalId","archived","customerId","locationId","addressId","combination"],"additionalProperties":false},"recordedStatus":{"type":"string","enum":["PENDING","ACTIVE","EXPIRED"]},"effectiveState":{"type":"string","enum":["pending","current","expired","incomplete"]},"renewalState":{"type":"string","enum":["current","expiring","expired","renewed","not_tracked"]},"daysLeft":{"type":["integer","null"],"minimum":0},"validFrom":{"type":["string","null"],"format":"date-time"},"validTo":{"type":["string","null"],"format":"date-time"},"recordCompleteness":{"type":"string","enum":["populated","placeholder"]},"evidence":{"type":"object","properties":{"recordedState":{"type":"string","enum":["recorded","not_recorded","invalid_metadata"]},"fileName":{"type":["string","null"],"minLength":1}},"required":["recordedState","fileName"],"additionalProperties":false},"matchBasis":{"type":"array","items":{"type":"string","enum":["type_title","type_description","evidence_file_name","unfiltered"]},"minItems":1},"searchedFields":{"type":"array","items":{"type":"string","minLength":1}},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["user"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["system"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string","enum":["System User"]}},"required":["type","id","displayName"],"additionalProperties":false}]},"updatedAt":{"type":"string","format":"date-time"}},"required":["recordId","resourceKind","type","subject","recordedStatus","effectiveState","renewalState","daysLeft","validFrom","validTo","recordCompleteness","evidence","matchBasis","searchedFields","createdAt","createdBy","updatedAt"],"additionalProperties":false},"meta":{"type":"object","properties":{"capabilityKey":{"type":"string","enum":["get_certification_record"]},"capabilityVersion":{"type":"string","enum":["1.2.0"]},"evaluatedAt":{"type":"string","format":"date-time"},"currentState":{"type":"boolean","enum":[true]},"snapshotIsolatedAcrossRequests":{"type":"boolean","enum":[false]},"requestId":{"type":"string"}},"required":["capabilityKey","capabilityVersion","evaluatedAt","currentState","snapshotIsolatedAcrossRequests","requestId"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false},"PublicAPISearchResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","contact","product","order","purchase_order","location"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"subtitle":{"type":"string"},"url":{"type":"string"},"archived":{"type":"boolean"},"matchedFields":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"label":{"type":"string"},"value":{"type":"string"}},"required":["field","label","value"],"additionalProperties":false}},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false}},"required":["type","id","displayName","subtitle","url","archived","matchedFields"],"additionalProperties":false}},"meta":{"type":"object","properties":{"requestId":{"type":"string"},"limit":{"type":"integer"},"types":{"type":"array","items":{"type":"string","enum":["customer","supplier","contact","product","order","purchase_order","location"]}},"rankingIsContractual":{"type":"boolean","enum":[false]},"truncated":{"type":"boolean"},"durationMs":{"type":"number"}},"required":["requestId","limit","types","rankingIsContractual","truncated","durationMs"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false},"PublicAPIEntityResolutionResponse":{"type":"object","properties":{"data":{"oneOf":[{"type":"object","properties":{"classesSearched":{"type":"array","items":{"type":"string","enum":["customer","supplier","product","product_family","sales_order","purchase_order","salesperson","warehouse"]},"minItems":1},"classResults":{"type":"array","items":{"type":"object","properties":{"matchedClass":{"type":"string","enum":["customer","supplier","product","product_family","sales_order","purchase_order","salesperson","warehouse"]},"totalMatches":{"type":"integer","minimum":0}},"required":["matchedClass","totalMatches"],"additionalProperties":false}},"candidates":{"type":"array","items":{"type":"object","properties":{"entityId":{"type":"string","format":"uuid"},"displayName":{"type":"string","minLength":1,"maxLength":300},"matchedClass":{"type":"string","enum":["customer","supplier","product","product_family","sales_order","purchase_order","salesperson","warehouse"]},"matchRank":{"type":"string","enum":["exact","prefix","contains"]},"matchBasis":{"type":"string","enum":["canonical","product_code","external_id","alias","family","packaging","location","compound"]},"matchedValue":{"type":"string","minLength":1,"maxLength":300},"productCodes":{"type":"array","items":{"type":"string","minLength":1,"maxLength":120},"maxItems":50},"productIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":25},"memberCount":{"type":"integer","minimum":0},"productCodesComplete":{"type":"boolean"},"productIdsComplete":{"type":"boolean"}},"required":["entityId","displayName","matchedClass","matchRank","matchBasis","matchedValue"],"additionalProperties":false},"maxItems":30},"archivedRecordsExcluded":{"type":"boolean","enum":[true]},"selectionStatus":{"type":"string","enum":["auto_selected"]},"selectedCandidate":{"type":"object","properties":{"entityId":{"type":"string","format":"uuid"},"matchedClass":{"type":"string","enum":["customer","supplier","product","product_family","sales_order","purchase_order","salesperson","warehouse"]}},"required":["entityId","matchedClass"],"additionalProperties":false},"relatedTags":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","minLength":1},"description":{"type":["string","null"]},"matchedClasses":{"type":"array","items":{"type":"string","enum":["supplier","customer","product","product_family","contact","opportunity","sales_order","purchase_order","ship_to_address","ship_from_address"]},"maxItems":10}},"required":["label","description","matchedClasses"],"additionalProperties":false},"maxItems":5}},"required":["classesSearched","classResults","candidates","archivedRecordsExcluded","selectionStatus","selectedCandidate"],"additionalProperties":false},{"type":"object","properties":{"classesSearched":{"type":"array","items":{"type":"string","enum":["customer","supplier","product","product_family","sales_order","purchase_order","salesperson","warehouse"]},"minItems":1},"classResults":{"type":"array","items":{"type":"object","properties":{"matchedClass":{"type":"string","enum":["customer","supplier","product","product_family","sales_order","purchase_order","salesperson","warehouse"]},"totalMatches":{"type":"integer","minimum":0}},"required":["matchedClass","totalMatches"],"additionalProperties":false}},"candidates":{"type":"array","items":{"type":"object","properties":{"entityId":{"type":"string","format":"uuid"},"displayName":{"type":"string","minLength":1,"maxLength":300},"matchedClass":{"type":"string","enum":["customer","supplier","product","product_family","sales_order","purchase_order","salesperson","warehouse"]},"matchRank":{"type":"string","enum":["exact","prefix","contains"]},"matchBasis":{"type":"string","enum":["canonical","product_code","external_id","alias","family","packaging","location","compound"]},"matchedValue":{"type":"string","minLength":1,"maxLength":300},"productCodes":{"type":"array","items":{"type":"string","minLength":1,"maxLength":120},"maxItems":50},"productIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":25},"memberCount":{"type":"integer","minimum":0},"productCodesComplete":{"type":"boolean"},"productIdsComplete":{"type":"boolean"}},"required":["entityId","displayName","matchedClass","matchRank","matchBasis","matchedValue"],"additionalProperties":false},"maxItems":30},"archivedRecordsExcluded":{"type":"boolean","enum":[true]},"selectionStatus":{"type":"string","enum":["needs_clarification"]},"relatedTags":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","minLength":1},"description":{"type":["string","null"]},"matchedClasses":{"type":"array","items":{"type":"string","enum":["supplier","customer","product","product_family","contact","opportunity","sales_order","purchase_order","ship_to_address","ship_from_address"]},"maxItems":10}},"required":["label","description","matchedClasses"],"additionalProperties":false},"maxItems":5}},"required":["classesSearched","classResults","candidates","archivedRecordsExcluded","selectionStatus"],"additionalProperties":false},{"type":"object","properties":{"classesSearched":{"type":"array","items":{"type":"string","enum":["customer","supplier","product","product_family","sales_order","purchase_order","salesperson","warehouse"]},"minItems":1},"classResults":{"type":"array","items":{"type":"object","properties":{"matchedClass":{"type":"string","enum":["customer","supplier","product","product_family","sales_order","purchase_order","salesperson","warehouse"]},"totalMatches":{"type":"integer","minimum":0}},"required":["matchedClass","totalMatches"],"additionalProperties":false}},"candidates":{"type":"array","items":{"type":"object","properties":{"entityId":{"type":"string","format":"uuid"},"displayName":{"type":"string","minLength":1,"maxLength":300},"matchedClass":{"type":"string","enum":["customer","supplier","product","product_family","sales_order","purchase_order","salesperson","warehouse"]},"matchRank":{"type":"string","enum":["exact","prefix","contains"]},"matchBasis":{"type":"string","enum":["canonical","product_code","external_id","alias","family","packaging","location","compound"]},"matchedValue":{"type":"string","minLength":1,"maxLength":300},"productCodes":{"type":"array","items":{"type":"string","minLength":1,"maxLength":120},"maxItems":50},"productIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":25},"memberCount":{"type":"integer","minimum":0},"productCodesComplete":{"type":"boolean"},"productIdsComplete":{"type":"boolean"}},"required":["entityId","displayName","matchedClass","matchRank","matchBasis","matchedValue"],"additionalProperties":false},"maxItems":30},"archivedRecordsExcluded":{"type":"boolean","enum":[true]},"selectionStatus":{"type":"string","enum":["no_match"]},"relatedTags":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","minLength":1},"description":{"type":["string","null"]},"matchedClasses":{"type":"array","items":{"type":"string","enum":["supplier","customer","product","product_family","contact","opportunity","sales_order","purchase_order","ship_to_address","ship_from_address"]},"maxItems":10}},"required":["label","description","matchedClasses"],"additionalProperties":false},"maxItems":5}},"required":["classesSearched","classResults","candidates","archivedRecordsExcluded","selectionStatus"],"additionalProperties":false}]},"meta":{"type":"object","properties":{"capabilityKey":{"type":"string","enum":["resolve_entity"]},"capabilityVersion":{"type":"string","enum":["1.2.0"]}},"required":["capabilityKey","capabilityVersion"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false},"PublicAPITagsResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"label":{"type":"string","minLength":1},"description":{"type":["string","null"]},"applicableEntityTypes":{"type":"array","items":{"type":"string","enum":["supplier","customer","product","product_family","contact","opportunity","sales_order","purchase_order","ship_to_address","ship_from_address"]},"minItems":1,"maxItems":10}},"required":["id","label","description","applicableEntityTypes"],"additionalProperties":false}},"meta":{"type":"object","properties":{"capabilityKey":{"type":"string","enum":["list_tags"]},"capabilityVersion":{"type":"string","minLength":1},"returnedRecords":{"type":"integer","minimum":0},"populationCount":{"type":["integer","null"],"minimum":0},"complete":{"type":"boolean"},"hasMore":{"type":"boolean"},"nextCursor":{"type":["string","null"]},"ordering":{"type":"string","enum":["label_id"]},"currentState":{"type":"boolean","enum":[true]},"snapshotIsolatedAcrossRequests":{"type":"boolean","enum":[false]},"requestId":{"type":"string"}},"required":["capabilityKey","capabilityVersion","returnedRecords","populationCount","complete","hasMore","nextCursor","ordering","currentState","snapshotIsolatedAcrossRequests","requestId"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false},"PublicAPITaggedRecordsResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"resolvedTag":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"label":{"type":"string","minLength":1},"description":{"type":["string","null"]}},"required":["id","label","description"],"additionalProperties":false},"records":{"type":"array","items":{"type":"object","properties":{"entityType":{"type":"string","enum":["supplier","customer","product","product_family","contact","opportunity","sales_order","purchase_order","ship_to_address","ship_from_address"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string","minLength":1},"externalId":{"type":["string","null"]},"archived":{"type":"boolean"}},"required":["entityType","id","displayName","externalId","archived"],"additionalProperties":false}}},"required":["resolvedTag","records"],"additionalProperties":false},"meta":{"type":"object","properties":{"capabilityKey":{"type":"string","enum":["find_tagged_records"]},"capabilityVersion":{"type":"string","minLength":1},"returnedRecords":{"type":"integer","minimum":0},"populationCount":{"type":["integer","null"],"minimum":0},"complete":{"type":"boolean"},"hasMore":{"type":"boolean"},"nextCursor":{"type":["string","null"]},"ordering":{"type":"string","enum":["display_name_id"]},"currentState":{"type":"boolean","enum":[true]},"snapshotIsolatedAcrossRequests":{"type":"boolean","enum":[false]},"requestId":{"type":"string"},"archivedExcluded":{"type":"boolean"}},"required":["capabilityKey","capabilityVersion","returnedRecords","populationCount","complete","hasMore","nextCursor","ordering","currentState","snapshotIsolatedAcrossRequests","requestId","archivedExcluded"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false},"PublicAPITagMutationResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"label":{"type":"string","minLength":1},"description":{"type":["string","null"]},"applicableEntityTypes":{"type":"array","items":{"type":"string","enum":["supplier","customer","product","product_family","contact","opportunity","sales_order","purchase_order","ship_to_address","ship_from_address"]},"description":"Public classes this tag applies to. Unrestricted tags list every class; send that full roster or omit the field on create to keep a tag unrestricted. A subset restricts the tag and unlinks assignments outside the set."},"changed":{"type":"boolean"},"removedEntityTypes":{"type":"array","items":{"type":"string","enum":["supplier","customer","product","product_family","contact","opportunity","sales_order","purchase_order","ship_to_address","ship_from_address"]}}},"required":["id","label","description","applicableEntityTypes","changed"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},"PublicAPITagAssignmentMutationResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"tag":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"label":{"type":"string","minLength":1},"description":{"type":["string","null"]},"applicableEntityTypes":{"type":"array","items":{"type":"string","enum":["supplier","customer","product","product_family","contact","opportunity","sales_order","purchase_order","ship_to_address","ship_from_address"]},"description":"Public classes this tag applies to. Unrestricted tags list every class; send that full roster or omit the field on create to keep a tag unrestricted. A subset restricts the tag and unlinks assignments outside the set."},"changed":{"type":"boolean"}},"required":["id","label","description","applicableEntityTypes","changed"],"additionalProperties":false},"entityType":{"type":"string","enum":["supplier","customer","product","product_family","contact","opportunity","sales_order","purchase_order","ship_to_address","ship_from_address"]},"assignments":{"type":"array","items":{"type":"object","properties":{"entityClass":{"type":"string","enum":["supplier","customer","product","product_family","contact","opportunity","sales_order","purchase_order","ship_to_address","ship_from_address"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string","minLength":1},"externalId":{"type":["string","null"]},"archived":{"type":"boolean"},"entityId":{"type":"string","format":"uuid"},"changed":{"type":"boolean"}},"required":["entityClass","id","displayName","externalId","archived","entityId","changed"],"additionalProperties":false}}},"required":["tag","entityType","assignments"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},"PublicAPITagAssignmentsResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"entityType":{"type":"string","enum":["supplier","customer","product","product_family","contact","opportunity","sales_order","purchase_order","ship_to_address","ship_from_address"]},"entityId":{"type":"string","format":"uuid"},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"label":{"type":"string","minLength":1},"description":{"type":["string","null"]},"applicableEntityTypes":{"type":"array","items":{"type":"string","enum":["supplier","customer","product","product_family","contact","opportunity","sales_order","purchase_order","ship_to_address","ship_from_address"]},"description":"Public classes this tag applies to. Unrestricted tags list every class; send that full roster or omit the field on create to keep a tag unrestricted. A subset restricts the tag and unlinks assignments outside the set."},"changed":{"type":"boolean"}},"required":["id","label","description","applicableEntityTypes","changed"],"additionalProperties":false}}},"required":["entityType","entityId","tags"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},"PublicAPIProductDirectoryResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"entityClass":{"type":"string","enum":["product","product_family"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string","minLength":1},"matchedQueries":{"type":"array","items":{"type":"string"}},"familyName":{"type":["string","null"]},"casNumber":{"type":["string","null"]},"unNumber":{"type":["string","null"]},"properShippingName":{"type":["string","null"]},"hazardClass":{"type":["string","null"]},"packingGroup":{"type":["string","null"]},"matchBasis":{"type":["string","null"],"enum":["sku","family"]},"externalId":{"type":["string","null"]},"archived":{"type":["boolean","null"]},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["user"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["system"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string","enum":["System User"]}},"required":["type","id","displayName"],"additionalProperties":false}]}},"required":["entityClass","id","displayName","familyName","casNumber","unNumber","properShippingName","hazardClass","packingGroup","matchBasis","externalId","archived","createdAt","createdBy"],"additionalProperties":false}},"meta":{"type":"object","properties":{"capabilityKey":{"type":"string","enum":["find_products"]},"capabilityVersion":{"type":"string","minLength":1},"returnedRecords":{"type":"integer","minimum":0},"populationCount":{"type":["integer","null"],"minimum":0},"complete":{"type":"boolean"},"hasMore":{"type":"boolean"},"nextCursor":{"type":["string","null"]},"ordering":{"type":"string","enum":["display_name_entity_type_id"]},"currentState":{"type":"boolean","enum":[true]},"snapshotIsolatedAcrossRequests":{"type":"boolean","enum":[false]},"requestId":{"type":"string"},"nameQueryCounts":{"type":"array","items":{"type":"object","properties":{"query":{"type":"string"},"count":{"type":"integer","minimum":0},"complete":{"type":"boolean"}},"required":["query","count","complete"],"additionalProperties":false}},"unmatchedQueries":{"type":"array","items":{"type":"string"}},"archivedExcluded":{"type":"boolean"},"searchedIdentifierSpaces":{"type":"array","items":{"type":"string","enum":["un_number","cas_number","hazard_class","packing_group","name"]}}},"required":["capabilityKey","capabilityVersion","returnedRecords","populationCount","complete","hasMore","nextCursor","ordering","currentState","snapshotIsolatedAcrossRequests","requestId","archivedExcluded","searchedIdentifierSpaces"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false},"PublicAPISupplierHistoryResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"currencyCode":{"type":"string","minLength":3,"maxLength":3},"timezone":{"type":"string"},"observedAt":{"type":"string"},"limit":{"type":"integer","exclusiveMinimum":0},"suppliers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"products":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"code":{"type":"string"},"name":{"type":["string","null"]},"archived":{"type":"boolean","enum":[false]},"family":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false},"package":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"quantity":{"type":"string"},"uom":{"type":"string"},"type":{"type":"string"}},"required":["id","name","quantity","uom","type"],"additionalProperties":false},"supplierNames":{"type":"array","items":{"type":"string"}},"admittedBy":{"type":"array","items":{"type":"string","enum":["linked","purchased","arrangement"]}},"matchedQueries":{"type":"array","items":{"type":"string"}},"lastCompletedPurchase":{"type":["object","null"],"properties":{"materialCost":{"type":"object","properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string","minLength":3,"maxLength":3},"uom":{"type":"string"},"comparisonBasis":{"type":"string","enum":["material","landed","unclassified"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom","comparisonBasis"],"additionalProperties":false},"landedCost":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string","minLength":3,"maxLength":3},"uom":{"type":"string"},"comparisonBasis":{"type":"string","enum":["material","landed","unclassified"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom","comparisonBasis"],"additionalProperties":false},"sourceDate":{"type":"string"},"observedAt":{"type":"string"},"status":{"type":"string","enum":["completed","pending"]},"sourceReference":{"type":"string"}},"required":["materialCost","landedCost","sourceDate","observedAt","status","sourceReference"],"additionalProperties":false},"latestOnOrderPurchase":{"type":["object","null"],"properties":{"materialCost":{"type":"object","properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string","minLength":3,"maxLength":3},"uom":{"type":"string"},"comparisonBasis":{"type":"string","enum":["material","landed","unclassified"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom","comparisonBasis"],"additionalProperties":false},"landedCost":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string","minLength":3,"maxLength":3},"uom":{"type":"string"},"comparisonBasis":{"type":"string","enum":["material","landed","unclassified"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom","comparisonBasis"],"additionalProperties":false},"sourceDate":{"type":"string"},"observedAt":{"type":"string"},"status":{"type":"string","enum":["completed","pending"]},"sourceReference":{"type":"string"}},"required":["materialCost","landedCost","sourceDate","observedAt","status","sourceReference"],"additionalProperties":false},"arrangements":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"kind":{"type":"string","enum":["GENERAL","AT_PICKUP","AT_DESTINATION"]},"shipFromLocationId":{"type":["string","null"],"format":"uuid"},"destinationCity":{"type":["string","null"]},"destinationState":{"type":["string","null"]},"destinationCountryCode":{"type":["string","null"]},"latestCost":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"starting":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string","minLength":3,"maxLength":3},"uom":{"type":"string"},"comparisonBasis":{"type":"string","enum":["material","landed","unclassified"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom","comparisonBasis"],"additionalProperties":false},"added":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string","minLength":3,"maxLength":3},"uom":{"type":"string"},"comparisonBasis":{"type":"string","enum":["material","landed","unclassified"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom","comparisonBasis"],"additionalProperties":false},"total":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string","minLength":3,"maxLength":3},"uom":{"type":"string"},"comparisonBasis":{"type":"string","enum":["material","landed","unclassified"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom","comparisonBasis"],"additionalProperties":false},"additionalCosts":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"integer"},"class":{"type":"string"},"method":{"type":"string","enum":["percent_of_starting_cost","cents_per_base_uom","cents_per_package"]},"value":{"type":"string"},"description":{"type":["string","null"]},"resolvedContribution":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string","minLength":3,"maxLength":3},"uom":{"type":"string"},"comparisonBasis":{"type":"string","enum":["material","landed","unclassified"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom","comparisonBasis"],"additionalProperties":false}},"required":["sequence","class","method","value","description","resolvedContribution"],"additionalProperties":false}},"rates":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"integer","minimum":0},"amount":{"type":"object","properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string","minLength":3,"maxLength":3},"uom":{"type":"string","minLength":1}},"required":["decimalCentsPerBaseUom","currencyCode","uom"],"additionalProperties":false},"minimumQuantity":{"type":["string","null"]},"minimumBasis":{"type":["string","null"],"enum":["product_uom","package"]},"minimumPackage":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","minLength":1},"quantity":{"type":"string"},"uom":{"type":"string","minLength":1}},"required":["id","name","quantity","uom"],"additionalProperties":false}},"required":["sequence","amount","minimumQuantity","minimumBasis","minimumPackage"],"additionalProperties":false}},"effectiveFrom":{"type":"string"},"effectiveTo":{"type":["string","null"]},"state":{"type":"string"},"note":{"type":["string","null"]},"warningCodes":{"type":"array","items":{"type":"string"}}},"required":["id","starting","added","total","additionalCosts","rates","effectiveFrom","effectiveTo","state","note","warningCodes"],"additionalProperties":false}},"required":["id","name","kind","shipFromLocationId","destinationCity","destinationState","destinationCountryCode","latestCost"],"additionalProperties":false}}},"required":["id","code","name","archived","family","package","supplierNames","admittedBy","matchedQueries","lastCompletedPurchase","latestOnOrderPurchase","arrangements"],"additionalProperties":false}},"shipFromLocations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"city":{"type":["string","null"]},"state":{"type":["string","null"]}},"required":["id","name","city","state"],"additionalProperties":false}},"coverage":{"type":"object","properties":{"complete":{"type":"boolean"},"scope":{"type":"string","enum":["supplier","names","products","names_and_products"]},"returnedProducts":{"type":"integer"},"returnedArrangements":{"type":"integer","minimum":0},"returnedSavedCosts":{"type":"integer","minimum":0},"reason":{"type":["string","null"]}},"required":["complete","scope","returnedProducts","returnedArrangements","returnedSavedCosts","reason"],"additionalProperties":false},"nameQueryCounts":{"type":"array","items":{"type":"object","properties":{"query":{"type":"string"},"count":{"type":"integer"},"complete":{"type":"boolean"}},"required":["query","count","complete"],"additionalProperties":false}},"unmatchedQueries":{"type":"array","items":{"type":"string"}}},"required":["id","name","products","shipFromLocations","coverage","nameQueryCounts","unmatchedQueries"],"additionalProperties":false}}},"required":["currencyCode","timezone","observedAt","limit","suppliers"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},"PublicAPINoteResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["note"]},"url":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"object","properties":{"type":{"type":"string","enum":["user"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"createdVia":{"type":["object","null"],"properties":{"type":{"type":"string","enum":["public_api"]},"actorUserId":{"type":"string","format":"uuid"}},"required":["type","actorUserId"],"additionalProperties":false},"requestedVia":{"type":"object","properties":{"type":{"type":"string","enum":["api_key"]},"id":{"type":"string","format":"uuid"},"purpose":{"type":["string","null"]}},"required":["type","id","purpose"],"additionalProperties":false},"noteType":{"type":"string","enum":["PHONE_MEETING","PHYSICAL_MEETING","VIRTUAL_MEETING","NOTE","EMAIL","SAMPLE_REQUEST","OPPORTUNITY","QUOTE"]},"title":{"type":"string"},"body":{"type":"string"},"happenedAt":{"type":"string","format":"date-time"},"primarySubject":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["customer"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["supplier"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["product"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["redacted"]},"recordType":{"type":"string","enum":["customer","supplier","product"]}},"required":["type","recordType"],"additionalProperties":false}]},"linkedRecords":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["customer"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["supplier"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["product"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["contact"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["location"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["user"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["redacted"]},"recordType":{"type":"string","enum":["customer","supplier","product","contact","location"]}},"required":["type","recordType"],"additionalProperties":false}]}},"externalId":{"type":["string","null"]},"idempotencyStatus":{"type":"string","enum":["created","replayed","updated","fetched"]}},"required":["id","type","url","createdAt","updatedAt","createdBy","createdVia","requestedVia","noteType","title","body","happenedAt","primarySubject","linkedRecords","externalId","idempotencyStatus"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},"PublicAPINoteListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["note"]},"url":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"object","properties":{"type":{"type":"string","enum":["user"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"noteType":{"type":"string","enum":["PHONE_MEETING","PHYSICAL_MEETING","VIRTUAL_MEETING","NOTE","EMAIL","SAMPLE_REQUEST","OPPORTUNITY","QUOTE"]},"title":{"type":"string"},"externalId":{"type":["string","null"]},"happenedAt":{"type":"string","format":"date-time"},"primarySubject":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["customer"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["supplier"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["product"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["redacted"]},"recordType":{"type":"string","enum":["customer","supplier","product"]}},"required":["type","recordType"],"additionalProperties":false}]},"linkedRecords":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["customer"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["supplier"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["product"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["contact"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["location"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["user"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["redacted"]},"recordType":{"type":"string","enum":["customer","supplier","product","contact","location"]}},"required":["type","recordType"],"additionalProperties":false}]}},"apiCreated":{"type":"boolean"}},"required":["id","type","url","createdAt","updatedAt","createdBy","noteType","title","externalId","happenedAt","primarySubject","linkedRecords","apiCreated"],"additionalProperties":false}},"meta":{"type":"object","properties":{"requestId":{"type":"string"},"mode":{"type":"string"},"limit":{"type":"integer"},"hasMore":{"type":"boolean"},"filters":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"changedRecordBasis":{"type":"string","enum":["parent_updated_at"]},"narrowingHints":{"type":"array","items":{"type":"string"}}},"required":["requestId","mode","limit","hasMore","filters"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false},"PublicAPINoteActivityResponse":{"anyOf":[{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"dimensionKey":{"type":"string"},"dimensionLabel":{"type":"string"},"noteCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"dimensionType":{"type":["string","null"],"enum":["BILL","BILL_CREDIT_NOTE","BULK_PAYMENT","CERT","CONTACT","COST_DERIVATION","CREDIT_NOTE","CUSTOMER","CUSTOMER_NOTE","CUSTOMER_PAYMENT","DEPOSIT","INVOICE","LEDGER_TRANSACTION","OPPORTUNITY","ORDER","PRODUCT","PRODUCT_FAMILY","PURCHASE_ORDER","RELATIONSHIP","SHIP_FROM_ADDRESS","SHIP_TO_ADDRESS","SUPPLIER","SUPPLIER_COST","SUPPLIER_PAYMENT","USER","WAREHOUSE","WORK_ORDER"]},"dimensionId":{"type":["string","null"],"format":"uuid"}},"required":["dimensionKey","dimensionLabel","noteCount"],"additionalProperties":false}},"meta":{"type":"object","properties":{"windowFrom":{"type":"string","format":"date-time"},"windowTo":{"type":"string","format":"date-time"},"timezone":{"type":"string"},"totalNotes":{"type":"integer","minimum":0},"limit":{"type":"integer","exclusiveMinimum":0},"hasMore":{"type":"boolean"},"nextCursor":{"type":["string","null"]},"warnings":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"generatedAt":{"type":"string","format":"date-time"},"view":{"type":"string","enum":["activity"]},"groupBy":{"type":"string","enum":["day","noteType","author","subject"]}},"required":["windowFrom","windowTo","timezone","totalNotes","limit","hasMore","nextCursor","warnings","generatedAt","view","groupBy"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"happenedDay":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"createdAt":{"type":"string","format":"date-time"},"noteType":{"type":"string","enum":["PHONE_MEETING","PHYSICAL_MEETING","VIRTUAL_MEETING","NOTE","EMAIL","SAMPLE_REQUEST","OPPORTUNITY","QUOTE"]},"title":{"type":"string"},"author":{"type":"string"},"subjectType":{"type":["string","null"],"enum":["BILL","BILL_CREDIT_NOTE","BULK_PAYMENT","CERT","CONTACT","COST_DERIVATION","CREDIT_NOTE","CUSTOMER","CUSTOMER_NOTE","CUSTOMER_PAYMENT","DEPOSIT","INVOICE","LEDGER_TRANSACTION","OPPORTUNITY","ORDER","PRODUCT","PRODUCT_FAMILY","PURCHASE_ORDER","RELATIONSHIP","SHIP_FROM_ADDRESS","SHIP_TO_ADDRESS","SUPPLIER","SUPPLIER_COST","SUPPLIER_PAYMENT","USER","WAREHOUSE","WORK_ORDER"]},"subjectId":{"type":["string","null"],"format":"uuid"},"subjectName":{"type":"string"},"excerpt":{"type":"string","maxLength":240}},"required":["id","happenedDay","createdAt","noteType","title","author","subjectType","subjectId","subjectName","excerpt"],"additionalProperties":false}},"meta":{"type":"object","properties":{"windowFrom":{"type":"string","format":"date-time"},"windowTo":{"type":"string","format":"date-time"},"timezone":{"type":"string"},"totalNotes":{"type":"integer","minimum":0},"limit":{"type":"integer","exclusiveMinimum":0},"hasMore":{"type":"boolean"},"nextCursor":{"type":["string","null"]},"warnings":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"generatedAt":{"type":"string","format":"date-time"},"view":{"type":"string","enum":["list"]},"groupBy":{"type":"null"}},"required":["windowFrom","windowTo","timezone","totalNotes","limit","hasMore","nextCursor","warnings","generatedAt","view","groupBy"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}]},"PublicAPIContactResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["contact"]},"id":{"type":"string","format":"uuid"},"contactKind":{"type":"string","enum":["customer","supplier"]},"displayName":{"type":"string"},"subtitle":{"type":"string"},"url":{"type":"string"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"name":{"type":"string"},"externalId":{"type":["string","null"]},"title":{"type":["string","null"]},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"mobilePhone":{"type":["string","null"]},"faxNumber":{"type":["string","null"]},"isEmergency":{"type":"boolean"},"documentTypes":{"type":"array","items":{"anyOf":[{"type":"string","enum":["AR_LETTER","PRICE_QUOTE","SALES_CONFIRMATION","INVOICE","CREDIT_NOTE"]},{"type":"string","enum":["PURCHASE_ORDERS","BILLS","MARKETING","LOGISTICS","WAREHOUSE","CALL_REPORTS"]}]}},"createdVia":{"type":["object","null"],"properties":{"type":{"type":"string","enum":["public_api"]},"actorUserId":{"type":"string","format":"uuid"}},"required":["type","actorUserId"],"additionalProperties":false},"requestedVia":{"type":"object","properties":{"type":{"type":"string","enum":["api_key"]},"id":{"type":"string","format":"uuid"},"purpose":{"type":["string","null"]}},"required":["type","id","purpose"],"additionalProperties":false},"idempotencyStatus":{"type":"string","enum":["created","replayed","updated","fetched"]}},"required":["type","id","contactKind","displayName","subtitle","url","parent","createdAt","updatedAt","name","externalId","title","email","phone","mobilePhone","faxNumber","isEmergency","documentTypes","createdVia","requestedVia","idempotencyStatus"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},"PublicAPIContactListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact"]},"id":{"type":"string","format":"uuid"},"contactKind":{"type":"string","enum":["customer","supplier"]},"displayName":{"type":"string"},"url":{"type":"string"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"archived":{"type":"boolean"},"externalId":{"type":["string","null"]},"name":{"type":"string"},"title":{"type":["string","null"]},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"mobilePhone":{"type":["string","null"]},"faxNumber":{"type":["string","null"]},"isEmergency":{"type":"boolean"},"documentTypes":{"type":"array","items":{"anyOf":[{"type":"string","enum":["AR_LETTER","PRICE_QUOTE","SALES_CONFIRMATION","INVOICE","CREDIT_NOTE"]},{"type":"string","enum":["PURCHASE_ORDERS","BILLS","MARKETING","LOGISTICS","WAREHOUSE","CALL_REPORTS"]}]}},"updatedAt":{"type":"string","format":"date-time"}},"required":["type","id","contactKind","displayName","url","parent","archived","externalId","name","title","email","phone","mobilePhone","faxNumber","isEmergency","documentTypes","updatedAt"],"additionalProperties":false}},"meta":{"type":"object","properties":{"requestId":{"type":"string"},"mode":{"type":"string"},"limit":{"type":"integer"},"hasMore":{"type":"boolean"},"filters":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"changedRecordBasis":{"type":"string","enum":["parent_updated_at"]},"narrowingHints":{"type":"array","items":{"type":"string"}}},"required":["requestId","mode","limit","hasMore","filters"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false},"PublicAPICustomerFinderResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["customer"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"externalId":{"type":["string","null"]},"pipelineStatus":{"type":["string","null"]},"primaryLocation":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"primary":{"type":"boolean"},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"website":{"type":["string","null"]},"updatedAt":{"type":"string","format":"date-time"},"accountOwner":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":["string","null"]},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"}},"required":["id","firstName","lastName","externalId","archivedAt"],"additionalProperties":false},"paymentTerms":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"externalId":{"type":["string","null"]}},"required":["id","name","externalId"],"additionalProperties":false},"customerServiceRepresentative":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":["string","null"]},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"}},"required":["id","firstName","lastName","externalId","archivedAt"],"additionalProperties":false},"archived":{"type":"boolean"}},"required":["id","name","primary","email","phone","website","updatedAt","accountOwner","paymentTerms","customerServiceRepresentative","archived"],"additionalProperties":false},"primaryAddress":{"type":["object","null"],"properties":{"id":{"type":["string","null"],"format":"uuid"},"name":{"type":["string","null"]},"street1":{"type":["string","null"]},"street2":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"zip":{"type":["string","null"]},"country":{"type":["string","null"]},"phone":{"type":["string","null"]},"email":{"type":["string","null"]}},"required":["id","name","street1","street2","city","state","zip","country","phone","email"],"additionalProperties":false},"owners":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":["string","null"]},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"}},"required":["id","firstName","lastName","externalId","archivedAt"],"additionalProperties":false}},"commercialTermsState":{"type":"string","enum":["resolved","no_primary","ambiguous_primary"]},"primaryOwner":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":["string","null"]},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"}},"required":["id","firstName","lastName","externalId","archivedAt"],"additionalProperties":false},"paymentTerms":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"externalId":{"type":["string","null"]}},"required":["id","name","externalId"],"additionalProperties":false},"customerServiceRepresentative":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":["string","null"]},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"}},"required":["id","firstName","lastName","externalId","archivedAt"],"additionalProperties":false},"accountManager":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]}},"required":["id","firstName","lastName"],"additionalProperties":false},"locations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"primary":{"type":"boolean"},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"website":{"type":["string","null"]},"updatedAt":{"type":"string","format":"date-time"},"accountOwner":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":["string","null"]},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"}},"required":["id","firstName","lastName","externalId","archivedAt"],"additionalProperties":false},"paymentTerms":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"externalId":{"type":["string","null"]}},"required":["id","name","externalId"],"additionalProperties":false},"customerServiceRepresentative":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":["string","null"]},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"}},"required":["id","firstName","lastName","externalId","archivedAt"],"additionalProperties":false}},"required":["id","name","primary","email","phone","website","updatedAt","accountOwner","paymentTerms","customerServiceRepresentative"],"additionalProperties":false}},"locationCoverage":{"type":"object","properties":{"total":{"type":"integer"},"returned":{"type":"integer"},"truncated":{"type":"boolean"},"readbackPath":{"type":["string","null"]}},"required":["total","returned","truncated","readbackPath"],"additionalProperties":false},"url":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["user"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["system"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string","enum":["System User"]}},"required":["type","id","displayName"],"additionalProperties":false}]},"archived":{"type":"boolean"}},"required":["type","id","displayName","externalId","pipelineStatus","primaryLocation","primaryAddress","owners","commercialTermsState","primaryOwner","paymentTerms","customerServiceRepresentative","accountManager","locations","locationCoverage","url","updatedAt","createdAt","createdBy","archived"],"additionalProperties":false}},"meta":{"type":"object","properties":{"requestId":{"type":"string"},"mode":{"type":"string"},"limit":{"type":"integer"},"hasMore":{"type":"boolean"},"filters":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"changedRecordBasis":{"type":"string","enum":["parent_updated_at"]},"narrowingHints":{"type":"array","items":{"type":"string"}},"nextCursor":{"type":["string","null"]},"coverage":{"type":"object","properties":{"totalAccounts":{"type":"integer"},"returnedAccounts":{"type":"integer"},"truncated":{"type":"boolean"},"rowScope":{"type":"string","enum":["organization","assigned_salesperson"]},"negativeClosureEligible":{"type":"boolean"},"actorNotSalesperson":{"type":"boolean"},"activityBasis":{"type":"object","properties":{"applied":{"type":"boolean"},"presence":{"type":["string","null"],"enum":["any","none"]},"fromDate":{"type":["string","null"]},"toDate":{"type":["string","null"]},"definition":{"type":["string","null"]}},"required":["applied","presence","fromDate","toDate","definition"],"additionalProperties":false}},"required":["totalAccounts","returnedAccounts","truncated","rowScope","negativeClosureEligible","actorNotSalesperson","activityBasis"],"additionalProperties":false}},"required":["requestId","mode","limit","hasMore","filters","nextCursor","coverage"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false},"PublicAPISupplierFinderResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["supplier"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"externalId":{"type":["string","null"]},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"website":{"type":["string","null"]},"primaryShipFrom":{"type":["object","null"],"properties":{"id":{"type":["string","null"],"format":"uuid"},"name":{"type":["string","null"]},"street1":{"type":["string","null"]},"street2":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"zip":{"type":["string","null"]},"country":{"type":["string","null"]},"phone":{"type":["string","null"]},"email":{"type":["string","null"]}},"required":["id","name","street1","street2","city","state","zip","country","phone","email"],"additionalProperties":false},"url":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["user"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["system"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string","enum":["System User"]}},"required":["type","id","displayName"],"additionalProperties":false}]},"archived":{"type":"boolean"}},"required":["type","id","displayName","externalId","email","phone","website","primaryShipFrom","url","updatedAt","createdAt","createdBy","archived"],"additionalProperties":false}},"meta":{"type":"object","properties":{"requestId":{"type":"string"},"mode":{"type":"string"},"limit":{"type":"integer"},"hasMore":{"type":"boolean"},"filters":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"changedRecordBasis":{"type":"string","enum":["parent_updated_at"]},"narrowingHints":{"type":"array","items":{"type":"string"}},"nextCursor":{"type":["string","null"]}},"required":["requestId","mode","limit","hasMore","filters","nextCursor"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false},"PublicAPICustomerReferenceResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"externalId":{"type":["string","null"]},"alternateNames":{"type":"array","items":{"type":"string"}},"website":{"type":["string","null"]},"emailDomains":{"type":"array","items":{"type":"string"}},"phone":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"country":{"type":["string","null"]},"status":{"type":"string","enum":["active"]},"updatedAt":{"type":"string","format":"date-time"},"url":{"type":"string"},"type":{"type":"string","enum":["customer"]}},"required":["id","displayName","externalId","alternateNames","website","emailDomains","phone","city","state","country","status","updatedAt","url","type"],"additionalProperties":false}},"meta":{"type":"object","properties":{"requestId":{"type":"string"},"mode":{"type":"string","enum":["active_reference_directory"]},"resource":{"type":"string","enum":["customers","suppliers"]},"limit":{"type":"integer"},"hasMore":{"type":"boolean"},"truncated":{"type":"boolean"},"nextCursor":{"type":["string","null"]},"generatedAt":{"type":"string","format":"date-time"},"sort":{"type":"string","enum":["id_asc"]},"filters":{"type":"object","properties":{"includeArchived":{"type":"boolean","enum":[false]}},"required":["includeArchived"],"additionalProperties":false}},"required":["requestId","mode","resource","limit","hasMore","truncated","nextCursor","generatedAt","sort","filters"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false},"PublicAPISupplierReferenceResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"externalId":{"type":["string","null"]},"alternateNames":{"type":"array","items":{"type":"string"}},"website":{"type":["string","null"]},"emailDomains":{"type":"array","items":{"type":"string"}},"phone":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"country":{"type":["string","null"]},"status":{"type":"string","enum":["active"]},"updatedAt":{"type":"string","format":"date-time"},"url":{"type":"string"},"type":{"type":"string","enum":["supplier"]}},"required":["id","displayName","externalId","alternateNames","website","emailDomains","phone","city","state","country","status","updatedAt","url","type"],"additionalProperties":false}},"meta":{"type":"object","properties":{"requestId":{"type":"string"},"mode":{"type":"string","enum":["active_reference_directory"]},"resource":{"type":"string","enum":["customers","suppliers"]},"limit":{"type":"integer"},"hasMore":{"type":"boolean"},"truncated":{"type":"boolean"},"nextCursor":{"type":["string","null"]},"generatedAt":{"type":"string","format":"date-time"},"sort":{"type":"string","enum":["id_asc"]},"filters":{"type":"object","properties":{"includeArchived":{"type":"boolean","enum":[false]}},"required":["includeArchived"],"additionalProperties":false}},"required":["requestId","mode","resource","limit","hasMore","truncated","nextCursor","generatedAt","sort","filters"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false},"PublicAPIProductFamilyReferenceResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["product_family"]},"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"externalId":{"type":["string","null"]},"casNumber":{"type":["string","null"]},"molecularFormula":{"type":["string","null"]},"unNumbers":{"type":"array","items":{"type":"string"}},"ghsSignalWord":{"type":["string","null"],"enum":["DANGER","WARNING"]},"hazardSymbols":{"type":"array","items":{"type":"string"}},"updatedAt":{"type":"string","format":"date-time"},"url":{"type":"string"},"idempotencyStatus":{"type":"string","enum":["created","replayed"]}},"required":["type","id","name","externalId","casNumber","molecularFormula","unNumbers","ghsSignalWord","hazardSymbols","updatedAt","url"],"additionalProperties":false}},"meta":{"type":"object","properties":{"requestId":{"type":"string"},"mode":{"type":"string","enum":["product_reference_lookup"]},"resource":{"type":"string","enum":["product_families","product_packaging"]},"limit":{"type":"integer"},"hasMore":{"type":"boolean"},"truncated":{"type":"boolean"},"sort":{"type":"string","enum":["name_asc"]},"filters":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"nextCursor":{"type":["string","null"]}},"required":["requestId","mode","resource","limit","hasMore","truncated","sort","filters"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false},"PublicAPIProductFamilyReferenceDetailResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["product_family"]},"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"externalId":{"type":["string","null"]},"casNumber":{"type":["string","null"]},"molecularFormula":{"type":["string","null"]},"unNumbers":{"type":"array","items":{"type":"string"}},"ghsSignalWord":{"type":["string","null"],"enum":["DANGER","WARNING"]},"hazardSymbols":{"type":"array","items":{"type":"string"}},"updatedAt":{"type":"string","format":"date-time"},"url":{"type":"string"},"idempotencyStatus":{"type":"string","enum":["created","replayed"]}},"required":["type","id","name","externalId","casNumber","molecularFormula","unNumbers","ghsSignalWord","hazardSymbols","updatedAt","url"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},"PublicAPIProductPackagingReferenceResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["product_packaging"]},"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"unitOfMeasure":{"type":"string","enum":["GALLON","LITER","POUND","KILOGRAM","EACH","METRIC_TON","SHORT_TON"]},"isBulk":{"type":"boolean"},"tareWeightLbs":{"type":["string","null"]},"capacity":{"type":["string","null"]},"material":{"type":["string","null"]},"unSpecCode":{"type":["string","null"]},"maxGrossWeightLbs":{"type":["string","null"]},"updatedAt":{"type":"string","format":"date-time"}},"required":["type","id","name","unitOfMeasure","isBulk","tareWeightLbs","capacity","material","unSpecCode","maxGrossWeightLbs","updatedAt"],"additionalProperties":false}},"meta":{"type":"object","properties":{"requestId":{"type":"string"},"mode":{"type":"string","enum":["product_reference_lookup"]},"resource":{"type":"string","enum":["product_families","product_packaging"]},"limit":{"type":"integer"},"hasMore":{"type":"boolean"},"truncated":{"type":"boolean"},"sort":{"type":"string","enum":["name_asc"]},"filters":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"nextCursor":{"type":["string","null"]}},"required":["requestId","mode","resource","limit","hasMore","truncated","sort","filters"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false},"PublicAPIProductFinderResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["product"]},"id":{"type":"string","format":"uuid"},"code":{"type":"string"},"displayName":{"type":"string"},"productFamily":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false},"supplier":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"externalId":{"type":["string","null"]},"archived":{"type":"boolean"}},"required":["id","displayName","externalId","archived"],"additionalProperties":false},"packaging":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"unitOfMeasure":{"type":"string"}},"required":["id","name","unitOfMeasure"],"additionalProperties":false},"packagingType":{"type":["string","null"]},"hazmat":{"type":"object","properties":{"unNumber":{"type":["string","null"]},"properShippingName":{"type":["string","null"]},"hazardClass":{"type":"array","items":{"type":"string"}}},"required":["unNumber","properShippingName","hazardClass"],"additionalProperties":false},"url":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"},"archived":{"type":"boolean"}},"required":["type","id","code","displayName","productFamily","supplier","packaging","packagingType","hazmat","url","updatedAt","archived"],"additionalProperties":false}},"meta":{"type":"object","properties":{"requestId":{"type":"string"},"mode":{"type":"string"},"limit":{"type":"integer"},"hasMore":{"type":"boolean"},"filters":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"changedRecordBasis":{"type":"string","enum":["parent_updated_at"]},"narrowingHints":{"type":"array","items":{"type":"string"}}},"required":["requestId","mode","limit","hasMore","filters"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false},"PublicAPIOrderFinderResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time"},"createdBy":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["user"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["system"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string","enum":["System User"]}},"required":["type","id","displayName"],"additionalProperties":false}]},"object":{"type":"string","enum":["sales_order"]},"id":{"type":"string","format":"uuid"},"orderNo":{"type":"string"},"customerOrderNo":{"type":["string","null"]},"externalId":{"type":["string","null"]},"customer":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"externalId":{"type":["string","null"]},"url":{"type":"string"}},"required":["id","displayName","externalId","url"],"additionalProperties":false},"status":{"type":"string"},"orderType":{"type":"string"},"orderedAt":{"type":["string","null"],"format":"date-time"},"shipBy":{"type":["string","null"],"format":"date-time"},"requiredBy":{"type":["string","null"],"format":"date-time"},"shippedAt":{"type":["string","null"],"format":"date-time"},"deliveredAt":{"type":["string","null"],"format":"date-time"},"linkedPurchaseOrder":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"orderNo":{"type":"string"},"url":{"type":"string"}},"required":["id","orderNo","url"],"additionalProperties":false},"totals":{"type":"object","properties":{"totalAmountCents":{"type":"string"},"currency":{"type":"string","minLength":3,"maxLength":3}},"required":["totalAmountCents","currency"],"additionalProperties":false},"productIds":{"type":"array","items":{"type":"string","format":"uuid"}},"url":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"}},"required":["createdAt","createdBy","object","id","orderNo","customerOrderNo","externalId","customer","status","orderType","orderedAt","shipBy","requiredBy","shippedAt","deliveredAt","linkedPurchaseOrder","totals","productIds","url","updatedAt"],"additionalProperties":false}},"meta":{"type":"object","properties":{"requestId":{"type":"string"},"mode":{"type":"string","enum":["finder"]},"limit":{"type":"integer","exclusiveMinimum":0,"maximum":25},"returnedRows":{"type":"integer","minimum":0},"hasMore":{"type":"boolean"},"nextCursor":{"type":["string","null"]},"ordering":{"type":"string","enum":["business_date_desc_id_desc","updated_at_desc_id_desc"]},"snapshotAt":{"type":"string","format":"date-time"},"synchronizationGuidance":{"type":"string"}},"required":["requestId","mode","limit","returnedRows","hasMore","nextCursor","ordering","snapshotAt"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false},"PublicAPIPurchaseOrderFinderResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time"},"createdBy":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["user"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["system"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string","enum":["System User"]}},"required":["type","id","displayName"],"additionalProperties":false}]},"object":{"type":"string","enum":["purchase_order"]},"id":{"type":"string","format":"uuid"},"orderNo":{"type":"string"},"externalId":{"type":["string","null"]},"supplier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"externalId":{"type":["string","null"]},"url":{"type":"string"}},"required":["id","displayName","externalId","url"],"additionalProperties":false},"linkedSalesOrder":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"orderNo":{"type":"string"},"customerOrderNo":{"type":["string","null"]},"url":{"type":"string"}},"required":["id","orderNo","customerOrderNo","url"],"additionalProperties":false},"status":{"type":"string"},"orderType":{"type":"string"},"submittedAt":{"type":["string","null"],"format":"date-time"},"dueAt":{"type":["string","null"],"format":"date-time"},"fullyReceivedAt":{"type":["string","null"],"format":"date-time"},"totals":{"type":"object","properties":{"totalAmountCents":{"type":"string"},"currency":{"type":"string","minLength":3,"maxLength":3}},"required":["totalAmountCents","currency"],"additionalProperties":false},"productIds":{"type":"array","items":{"type":"string","format":"uuid"}},"url":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"}},"required":["createdAt","createdBy","object","id","orderNo","externalId","supplier","linkedSalesOrder","status","orderType","submittedAt","dueAt","fullyReceivedAt","totals","productIds","url","updatedAt"],"additionalProperties":false}},"meta":{"type":"object","properties":{"requestId":{"type":"string"},"mode":{"type":"string","enum":["finder"]},"limit":{"type":"integer","exclusiveMinimum":0,"maximum":25},"returnedRows":{"type":"integer","minimum":0},"hasMore":{"type":"boolean"},"nextCursor":{"type":["string","null"]},"ordering":{"type":"string","enum":["business_date_desc_id_desc","updated_at_desc_id_desc"]},"snapshotAt":{"type":"string","format":"date-time"},"synchronizationGuidance":{"type":"string"}},"required":["requestId","mode","limit","returnedRows","hasMore","nextCursor","ordering","snapshotAt"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false},"PublicAPICustomerDetailResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["customer"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"url":{"type":"string"},"archived":{"type":"boolean"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"externalId":{"type":["string","null"]},"pipelineStatus":{"type":["string","null"]},"owners":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":["string","null"]},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"}},"required":["id","firstName","lastName","externalId","archivedAt"],"additionalProperties":false}},"commercialTermsState":{"type":"string","enum":["resolved","no_primary","ambiguous_primary"]},"primaryOwner":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":["string","null"]},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"}},"required":["id","firstName","lastName","externalId","archivedAt"],"additionalProperties":false},"paymentTerms":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"externalId":{"type":["string","null"]}},"required":["id","name","externalId"],"additionalProperties":false},"customerServiceRepresentative":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":["string","null"]},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"}},"required":["id","firstName","lastName","externalId","archivedAt"],"additionalProperties":false},"accountManager":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]}},"required":["id","firstName","lastName"],"additionalProperties":false},"primaryLocation":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"website":{"type":["string","null"]},"archived":{"type":"boolean"},"creditLimit":{"type":"object","properties":{"amountCents":{"type":["integer","null"],"minimum":0,"maximum":2147483647},"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"}},"required":["amountCents","currencyCode"],"additionalProperties":false},"accountOwner":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":["string","null"]},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"}},"required":["id","firstName","lastName","externalId","archivedAt"],"additionalProperties":false},"paymentTerms":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"externalId":{"type":["string","null"]}},"required":["id","name","externalId"],"additionalProperties":false},"customerServiceRepresentative":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":["string","null"]},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"}},"required":["id","firstName","lastName","externalId","archivedAt"],"additionalProperties":false},"accountManager":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]}},"required":["id","firstName","lastName"],"additionalProperties":false}},"required":["id","name","email","phone","website","archived","creditLimit","accountOwner","paymentTerms","customerServiceRepresentative","accountManager"],"additionalProperties":false},"locations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"primary":{"type":"boolean"},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"website":{"type":["string","null"]},"archived":{"type":"boolean"},"creditLimit":{"type":"object","properties":{"amountCents":{"type":["integer","null"],"minimum":0,"maximum":2147483647},"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"}},"required":["amountCents","currencyCode"],"additionalProperties":false},"accountOwner":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":["string","null"]},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"}},"required":["id","firstName","lastName","externalId","archivedAt"],"additionalProperties":false},"paymentTerms":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"externalId":{"type":["string","null"]}},"required":["id","name","externalId"],"additionalProperties":false},"customerServiceRepresentative":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":["string","null"]},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"}},"required":["id","firstName","lastName","externalId","archivedAt"],"additionalProperties":false},"accountManager":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]}},"required":["id","firstName","lastName"],"additionalProperties":false}},"required":["id","name","primary","email","phone","website","archived","creditLimit","accountOwner","paymentTerms","customerServiceRepresentative","accountManager"],"additionalProperties":false}},"addresses":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"street1":{"type":["string","null"]},"street2":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"zip":{"type":["string","null"]},"country":{"type":["string","null"]},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"externalId":{"type":["string","null"]},"isBilling":{"type":"boolean"},"isShipping":{"type":"boolean"},"defaultOrderShippingRemarks":{"type":["string","null"]},"archived":{"type":"boolean"},"location":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"primary":{"type":"boolean"}},"required":["id","name","primary"],"additionalProperties":false}},"required":["id","name","street1","street2","city","state","zip","country","email","phone","externalId","isBilling","isShipping","defaultOrderShippingRemarks","archived","location"],"additionalProperties":false}},"contacts":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact"]},"id":{"type":"string","format":"uuid"},"contactKind":{"type":"string","enum":["customer","supplier"]},"displayName":{"type":"string"},"url":{"type":"string"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"archived":{"type":"boolean"},"externalId":{"type":["string","null"]},"name":{"type":"string"},"title":{"type":["string","null"]},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"mobilePhone":{"type":["string","null"]},"faxNumber":{"type":["string","null"]},"isEmergency":{"type":"boolean"},"documentTypes":{"type":"array","items":{"anyOf":[{"type":"string","enum":["AR_LETTER","PRICE_QUOTE","SALES_CONFIRMATION","INVOICE","CREDIT_NOTE"]},{"type":"string","enum":["PURCHASE_ORDERS","BILLS","MARKETING","LOGISTICS","WAREHOUSE","CALL_REPORTS"]}]}}},"required":["type","id","contactKind","displayName","url","parent","archived","externalId","name","title","email","phone","mobilePhone","faxNumber","isEmergency","documentTypes"],"additionalProperties":false}}},"required":["type","id","displayName","url","archived","createdAt","updatedAt","externalId","pipelineStatus","owners","commercialTermsState","primaryOwner","paymentTerms","customerServiceRepresentative","accountManager","primaryLocation","locations","addresses","contacts"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},"PublicAPICustomerLocationResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["customer_location"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"apiPath":{"type":"string"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"archived":{"type":"boolean"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"name":{"type":"string"},"primary":{"type":"boolean"},"email":{"type":["string","null"]},"website":{"type":["string","null"]},"phone":{"type":["string","null"]},"creditLimit":{"type":"object","properties":{"amountCents":{"type":["integer","null"],"minimum":0,"maximum":2147483647},"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"}},"required":["amountCents","currencyCode"],"additionalProperties":false},"accountOwner":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":["string","null"]},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"}},"required":["id","firstName","lastName","externalId","archivedAt"],"additionalProperties":false},"paymentTerms":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"externalId":{"type":["string","null"]}},"required":["id","name","externalId"],"additionalProperties":false},"customerServiceRepresentative":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":["string","null"]},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"}},"required":["id","firstName","lastName","externalId","archivedAt"],"additionalProperties":false},"accountManager":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]}},"required":["id","firstName","lastName"],"additionalProperties":false},"addresses":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["customer_address"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"apiPath":{"type":"string"},"archived":{"type":"boolean"},"name":{"type":"string"},"street1":{"type":["string","null"]},"street2":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"zip":{"type":["string","null"]},"country":{"type":["string","null"]},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"externalId":{"type":["string","null"]},"isBilling":{"type":"boolean"},"isShipping":{"type":"boolean"},"defaultOrderShippingRemarks":{"type":["string","null"]}},"required":["type","id","displayName","apiPath","archived","name","street1","street2","city","state","zip","country","email","phone","externalId","isBilling","isShipping","defaultOrderShippingRemarks"],"additionalProperties":false}},"addressesTruncated":{"type":"boolean"},"requestedVia":{"type":"object","properties":{"type":{"type":"string","enum":["api_key"]},"id":{"type":"string","format":"uuid"},"purpose":{"type":["string","null"]}},"required":["type","id","purpose"],"additionalProperties":false},"idempotencyStatus":{"type":"string","enum":["created","replayed","updated","fetched"]}},"required":["type","id","displayName","apiPath","parent","archived","createdAt","updatedAt","name","primary","email","website","phone","creditLimit","accountOwner","paymentTerms","customerServiceRepresentative","accountManager","addresses","addressesTruncated","requestedVia","idempotencyStatus"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},"PublicAPICustomerLocationListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["customer_location"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"apiPath":{"type":"string"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"archived":{"type":"boolean"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"name":{"type":"string"},"primary":{"type":"boolean"},"email":{"type":["string","null"]},"website":{"type":["string","null"]},"phone":{"type":["string","null"]},"creditLimit":{"type":"object","properties":{"amountCents":{"type":["integer","null"],"minimum":0,"maximum":2147483647},"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"}},"required":["amountCents","currencyCode"],"additionalProperties":false},"accountOwner":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":["string","null"]},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"}},"required":["id","firstName","lastName","externalId","archivedAt"],"additionalProperties":false},"paymentTerms":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"externalId":{"type":["string","null"]}},"required":["id","name","externalId"],"additionalProperties":false},"customerServiceRepresentative":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":["string","null"]},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"}},"required":["id","firstName","lastName","externalId","archivedAt"],"additionalProperties":false},"accountManager":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]}},"required":["id","firstName","lastName"],"additionalProperties":false},"addresses":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["customer_address"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"apiPath":{"type":"string"},"archived":{"type":"boolean"},"name":{"type":"string"},"street1":{"type":["string","null"]},"street2":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"zip":{"type":["string","null"]},"country":{"type":["string","null"]},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"externalId":{"type":["string","null"]},"isBilling":{"type":"boolean"},"isShipping":{"type":"boolean"},"defaultOrderShippingRemarks":{"type":["string","null"]}},"required":["type","id","displayName","apiPath","archived","name","street1","street2","city","state","zip","country","email","phone","externalId","isBilling","isShipping","defaultOrderShippingRemarks"],"additionalProperties":false}},"addressesTruncated":{"type":"boolean"},"requestedVia":{"type":"object","properties":{"type":{"type":"string","enum":["api_key"]},"id":{"type":"string","format":"uuid"},"purpose":{"type":["string","null"]}},"required":["type","id","purpose"],"additionalProperties":false},"idempotencyStatus":{"type":"string","enum":["created","replayed","updated","fetched"]}},"required":["type","id","displayName","apiPath","parent","archived","createdAt","updatedAt","name","primary","email","website","phone","creditLimit","accountOwner","paymentTerms","customerServiceRepresentative","accountManager","addresses","addressesTruncated","requestedVia","idempotencyStatus"],"additionalProperties":false}},"meta":{"type":"object","properties":{"requestId":{"type":"string"},"mode":{"type":"string","enum":["parent_scoped_child_list"]},"resource":{"type":"string","enum":["customer_locations","customer_addresses","supplier_ship_from_locations"]},"limit":{"type":"integer"},"hasMore":{"type":"boolean"},"truncated":{"type":"boolean"},"nextCursor":{"type":["string","null"]},"generatedAt":{"type":"string","format":"date-time"},"sort":{"type":"string","enum":["id_asc"]},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false}},"required":["requestId","mode","resource","limit","hasMore","truncated","nextCursor","generatedAt","sort","parent"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false},"PublicAPICustomerAddressResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["customer_address"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"apiPath":{"type":"string"},"archived":{"type":"boolean"},"name":{"type":"string"},"street1":{"type":["string","null"]},"street2":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"zip":{"type":["string","null"]},"country":{"type":["string","null"]},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"externalId":{"type":["string","null"]},"isBilling":{"type":"boolean"},"isShipping":{"type":"boolean"},"defaultOrderShippingRemarks":{"type":["string","null"]},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"location":{"type":"object","properties":{"type":{"type":"string","enum":["customer_location"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"primary":{"type":"boolean"},"archived":{"type":"boolean"}},"required":["type","id","displayName","primary","archived"],"additionalProperties":false},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"requestedVia":{"type":"object","properties":{"type":{"type":"string","enum":["api_key"]},"id":{"type":"string","format":"uuid"},"purpose":{"type":["string","null"]}},"required":["type","id","purpose"],"additionalProperties":false},"idempotencyStatus":{"type":"string","enum":["created","replayed","updated","fetched"]}},"required":["type","id","displayName","apiPath","archived","name","street1","street2","city","state","zip","country","email","phone","externalId","isBilling","isShipping","defaultOrderShippingRemarks","parent","location","createdAt","updatedAt","requestedVia","idempotencyStatus"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},"PublicAPICustomerAddressListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["customer_address"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"apiPath":{"type":"string"},"archived":{"type":"boolean"},"name":{"type":"string"},"street1":{"type":["string","null"]},"street2":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"zip":{"type":["string","null"]},"country":{"type":["string","null"]},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"externalId":{"type":["string","null"]},"isBilling":{"type":"boolean"},"isShipping":{"type":"boolean"},"defaultOrderShippingRemarks":{"type":["string","null"]},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"location":{"type":"object","properties":{"type":{"type":"string","enum":["customer_location"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"primary":{"type":"boolean"},"archived":{"type":"boolean"}},"required":["type","id","displayName","primary","archived"],"additionalProperties":false},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"requestedVia":{"type":"object","properties":{"type":{"type":"string","enum":["api_key"]},"id":{"type":"string","format":"uuid"},"purpose":{"type":["string","null"]}},"required":["type","id","purpose"],"additionalProperties":false},"idempotencyStatus":{"type":"string","enum":["created","replayed","updated","fetched"]}},"required":["type","id","displayName","apiPath","archived","name","street1","street2","city","state","zip","country","email","phone","externalId","isBilling","isShipping","defaultOrderShippingRemarks","parent","location","createdAt","updatedAt","requestedVia","idempotencyStatus"],"additionalProperties":false}},"meta":{"type":"object","properties":{"requestId":{"type":"string"},"mode":{"type":"string","enum":["parent_scoped_child_list"]},"resource":{"type":"string","enum":["customer_locations","customer_addresses","supplier_ship_from_locations"]},"limit":{"type":"integer"},"hasMore":{"type":"boolean"},"truncated":{"type":"boolean"},"nextCursor":{"type":["string","null"]},"generatedAt":{"type":"string","format":"date-time"},"sort":{"type":"string","enum":["id_asc"]},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false}},"required":["requestId","mode","resource","limit","hasMore","truncated","nextCursor","generatedAt","sort","parent"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false},"PublicAPISupplierDetailResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["supplier"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"url":{"type":"string"},"archived":{"type":"boolean"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"externalId":{"type":["string","null"]},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"website":{"type":["string","null"]},"taxId":{"type":["string","null"]},"creditLimit":{"type":"object","properties":{"amountCents":{"type":["integer","null"],"minimum":0,"maximum":2147483647},"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"}},"required":["amountCents","currencyCode"],"additionalProperties":false},"preferredUnitOfMeasure":{"type":"string","enum":["NoPreference","Metric","Imperial"]},"paymentTerms":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"externalId":{"type":["string","null"]}},"required":["id","name","externalId"],"additionalProperties":false},"costLedgerAccount":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"externalId":{"type":["string","null"]},"accountType":{"type":"string","enum":["ASSET","LIABILITY","EQUITY","REVENUE","EXPENSE"]}},"required":["id","name","externalId","accountType"],"additionalProperties":false},"supplierRepresentative":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":["string","null"]},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"}},"required":["id","firstName","lastName","externalId","archivedAt"],"additionalProperties":false},"address":{"type":"object","properties":{"street1":{"type":["string","null"]},"street2":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"zip":{"type":["string","null"]},"country":{"type":["string","null"]}},"required":["street1","street2","city","state","zip","country"],"additionalProperties":false},"contacts":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact"]},"id":{"type":"string","format":"uuid"},"contactKind":{"type":"string","enum":["customer","supplier"]},"displayName":{"type":"string"},"url":{"type":"string"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"archived":{"type":"boolean"},"externalId":{"type":["string","null"]},"name":{"type":"string"},"title":{"type":["string","null"]},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"mobilePhone":{"type":["string","null"]},"faxNumber":{"type":["string","null"]},"isEmergency":{"type":"boolean"},"documentTypes":{"type":"array","items":{"anyOf":[{"type":"string","enum":["AR_LETTER","PRICE_QUOTE","SALES_CONFIRMATION","INVOICE","CREDIT_NOTE"]},{"type":"string","enum":["PURCHASE_ORDERS","BILLS","MARKETING","LOGISTICS","WAREHOUSE","CALL_REPORTS"]}]}}},"required":["type","id","contactKind","displayName","url","parent","archived","externalId","name","title","email","phone","mobilePhone","faxNumber","isEmergency","documentTypes"],"additionalProperties":false}},"shipFromLocations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"externalId":{"type":["string","null"]},"street1":{"type":["string","null"]},"street2":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"zip":{"type":["string","null"]},"country":{"type":["string","null"]},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"defaultSupplierShippingInstructions":{"type":["string","null"]},"archived":{"type":"boolean"}},"required":["id","name","externalId","street1","street2","city","state","zip","country","email","phone","defaultSupplierShippingInstructions","archived"],"additionalProperties":false}}},"required":["type","id","displayName","url","archived","createdAt","updatedAt","externalId","email","phone","website","taxId","creditLimit","preferredUnitOfMeasure","paymentTerms","costLedgerAccount","supplierRepresentative","address","contacts","shipFromLocations"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},"PublicAPISupplierShipFromLocationResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["supplier_ship_from_location"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"apiPath":{"type":"string"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"archived":{"type":"boolean"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"externalId":{"type":["string","null"]},"name":{"type":"string"},"street1":{"type":["string","null"]},"street2":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"zip":{"type":["string","null"]},"country":{"type":["string","null"]},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"defaultSupplierShippingInstructions":{"type":["string","null"]},"requestedVia":{"type":"object","properties":{"type":{"type":"string","enum":["api_key"]},"id":{"type":"string","format":"uuid"},"purpose":{"type":["string","null"]}},"required":["type","id","purpose"],"additionalProperties":false},"idempotencyStatus":{"type":"string","enum":["created","replayed","updated","fetched"]}},"required":["type","id","displayName","apiPath","parent","archived","createdAt","updatedAt","externalId","name","street1","street2","city","state","zip","country","email","phone","defaultSupplierShippingInstructions","requestedVia","idempotencyStatus"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},"PublicAPISupplierShipFromLocationListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["supplier_ship_from_location"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"apiPath":{"type":"string"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"archived":{"type":"boolean"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"externalId":{"type":["string","null"]},"name":{"type":"string"},"street1":{"type":["string","null"]},"street2":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"zip":{"type":["string","null"]},"country":{"type":["string","null"]},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"defaultSupplierShippingInstructions":{"type":["string","null"]},"requestedVia":{"type":"object","properties":{"type":{"type":"string","enum":["api_key"]},"id":{"type":"string","format":"uuid"},"purpose":{"type":["string","null"]}},"required":["type","id","purpose"],"additionalProperties":false},"idempotencyStatus":{"type":"string","enum":["created","replayed","updated","fetched"]}},"required":["type","id","displayName","apiPath","parent","archived","createdAt","updatedAt","externalId","name","street1","street2","city","state","zip","country","email","phone","defaultSupplierShippingInstructions","requestedVia","idempotencyStatus"],"additionalProperties":false}},"meta":{"type":"object","properties":{"requestId":{"type":"string"},"mode":{"type":"string","enum":["parent_scoped_child_list"]},"resource":{"type":"string","enum":["customer_locations","customer_addresses","supplier_ship_from_locations"]},"limit":{"type":"integer"},"hasMore":{"type":"boolean"},"truncated":{"type":"boolean"},"nextCursor":{"type":["string","null"]},"generatedAt":{"type":"string","format":"date-time"},"sort":{"type":"string","enum":["id_asc"]},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false}},"required":["requestId","mode","resource","limit","hasMore","truncated","nextCursor","generatedAt","sort","parent"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false},"PublicAPIProductDetailResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["product"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"url":{"type":"string"},"archived":{"type":"boolean"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"code":{"type":"string"},"externalId":{"type":["string","null"]},"casNumber":{"type":["string","null"]},"ghsSignalWord":{"type":["string","null"]},"qty":{"type":["string","null"]},"packagingType":{"type":["string","null"],"enum":["FIXED","VARIABLE"]},"supplierType":{"type":["string","null"],"enum":["FIXED","VARIABLE"]},"freightClass":{"type":["string","null"]},"nmfcCode":{"type":["string","null"]},"netUnitWeightLbs":{"type":["string","null"]},"packagesPerPallet":{"type":["integer","null"]},"productFamily":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"casNumber":{"type":["string","null"]},"molecularFormula":{"type":["string","null"]},"unNumbers":{"type":"array","items":{"type":"string"}},"ghsSignalWord":{"type":["string","null"]},"hazardSymbols":{"type":"array","items":{"type":"string"}}},"required":["id","name","casNumber","molecularFormula","unNumbers","ghsSignalWord","hazardSymbols"],"additionalProperties":false},"supplier":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"archived":{"type":"boolean"}},"required":["id","displayName","archived"],"additionalProperties":false},"packaging":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"unitOfMeasure":{"type":"string"},"isBulk":{"type":"boolean"},"tareWeightLbs":{"type":["string","null"]},"capacity":{"type":["string","null"]},"material":{"type":["string","null"]},"unSpecCode":{"type":["string","null"]},"maxGrossWeightLbs":{"type":["string","null"]}},"required":["id","name","unitOfMeasure","isBulk","tareWeightLbs","capacity","material","unSpecCode","maxGrossWeightLbs"],"additionalProperties":false},"hazmat":{"type":"object","properties":{"unNumber":{"type":["string","null"]},"properShippingName":{"type":["string","null"]},"hazardClass":{"type":"array","items":{"type":"string"}},"packingGroup":{"type":["string","null"]},"specialDesignation":{"type":["string","null"]},"hazardSymbols":{"type":"array","items":{"type":"string"}}},"required":["unNumber","properShippingName","hazardClass","packingGroup","specialDesignation","hazardSymbols"],"additionalProperties":false},"catalog":{"type":"object","properties":{"family":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"externalId":{"type":["string","null"]}},"required":["id","externalId"],"additionalProperties":false},"packaging":{"type":"object","properties":{"id":{"type":"string","format":"uuid"}},"required":["id"],"additionalProperties":false},"archived":{"type":"boolean"},"links":{"type":"object","properties":{"attributeAssignments":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":"string"}},"required":["available","method","path"],"additionalProperties":false},"suppliers":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":"string"}},"required":["available","method","path"],"additionalProperties":false},"aliases":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":"string"}},"required":["available","method","path"],"additionalProperties":false},"customerPartNumbers":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":"string"}},"required":["available","method","path"],"additionalProperties":false}},"required":["attributeAssignments","suppliers","aliases","customerPartNumbers"],"additionalProperties":false}},"required":["family","packaging","archived","links"],"additionalProperties":false},"idempotencyStatus":{"type":"string","enum":["created","replayed"]}},"required":["type","id","displayName","url","archived","createdAt","updatedAt","code","externalId","casNumber","ghsSignalWord","qty","packagingType","supplierType","freightClass","nmfcCode","netUnitWeightLbs","packagesPerPallet","productFamily","supplier","packaging","hazmat","catalog"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},"PublicAPIProductCostContextResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"product":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"code":{"type":"string"},"displayName":{"type":"string"},"baseUom":{"type":"string"},"archived":{"type":"boolean","enum":[false]}},"required":["id","code","displayName","baseUom","archived"],"additionalProperties":false},"supplier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"archived":{"type":"boolean","enum":[false]}},"required":["id","displayName","archived"],"additionalProperties":false},"costBookAsOf":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"purchaseEvidenceObservedAt":{"type":"string","format":"date-time"},"currencyCode":{"type":"string","minLength":3,"maxLength":3},"currentCostBookEntry":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"entryType":{"type":"string","enum":["direct","constructed"]},"effectiveFrom":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"effectiveTo":{"type":["string","null"],"pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"cost":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string","minLength":3,"maxLength":3},"uom":{"type":"string"},"comparisonBasis":{"type":"string","enum":["material","landed","unclassified"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom","comparisonBasis"],"additionalProperties":false},"resolutionState":{"type":"string","enum":["resolved","quantity_required","unavailable"]},"completeness":{"type":"string","enum":["complete","unresolved"]},"warningCodes":{"type":"array","items":{"type":"string"}},"rates":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"integer","minimum":0},"amount":{"type":"object","properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string","minLength":3,"maxLength":3},"uom":{"type":"string","minLength":1}},"required":["decimalCentsPerBaseUom","currencyCode","uom"],"additionalProperties":false},"minimumQuantity":{"type":["string","null"]},"minimumBasis":{"type":["string","null"],"enum":["product_uom","package"]},"minimumPackage":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","minLength":1},"quantity":{"type":"string"},"uom":{"type":"string","minLength":1}},"required":["id","name","quantity","uom"],"additionalProperties":false}},"required":["sequence","amount","minimumQuantity","minimumBasis","minimumPackage"],"additionalProperties":false},"maxItems":50}},"required":["id","entryType","effectiveFrom","effectiveTo","cost","resolutionState","completeness","warningCodes","rates"],"additionalProperties":false},"priorCostBookEntry":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"entryType":{"type":"string","enum":["direct","constructed"]},"effectiveFrom":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"effectiveTo":{"type":["string","null"],"pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"cost":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string","minLength":3,"maxLength":3},"uom":{"type":"string"},"comparisonBasis":{"type":"string","enum":["material","landed","unclassified"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom","comparisonBasis"],"additionalProperties":false},"resolutionState":{"type":"string","enum":["resolved","quantity_required","unavailable"]},"completeness":{"type":"string","enum":["complete","unresolved"]},"warningCodes":{"type":"array","items":{"type":"string"}},"rates":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"integer","minimum":0},"amount":{"type":"object","properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string","minLength":3,"maxLength":3},"uom":{"type":"string","minLength":1}},"required":["decimalCentsPerBaseUom","currencyCode","uom"],"additionalProperties":false},"minimumQuantity":{"type":["string","null"]},"minimumBasis":{"type":["string","null"],"enum":["product_uom","package"]},"minimumPackage":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","minLength":1},"quantity":{"type":"string"},"uom":{"type":"string","minLength":1}},"required":["id","name","quantity","uom"],"additionalProperties":false}},"required":["sequence","amount","minimumQuantity","minimumBasis","minimumPackage"],"additionalProperties":false},"maxItems":50}},"required":["id","entryType","effectiveFrom","effectiveTo","cost","resolutionState","completeness","warningCodes","rates"],"additionalProperties":false},"lastCompletedPurchase":{"type":["object","null"],"properties":{"materialCost":{"type":"object","properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string","minLength":3,"maxLength":3},"uom":{"type":"string"},"comparisonBasis":{"type":"string","enum":["material","landed","unclassified"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom","comparisonBasis"],"additionalProperties":false},"landedCost":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string","minLength":3,"maxLength":3},"uom":{"type":"string"},"comparisonBasis":{"type":"string","enum":["material","landed","unclassified"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom","comparisonBasis"],"additionalProperties":false},"sourceDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"observedAt":{"type":"string","format":"date-time"},"status":{"type":"string","enum":["completed","pending"]},"sourceReference":{"type":"string","minLength":1}},"required":["materialCost","landedCost","sourceDate","observedAt","status","sourceReference"],"additionalProperties":false},"latestOnOrderPurchase":{"type":["object","null"],"properties":{"materialCost":{"type":"object","properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string","minLength":3,"maxLength":3},"uom":{"type":"string"},"comparisonBasis":{"type":"string","enum":["material","landed","unclassified"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom","comparisonBasis"],"additionalProperties":false},"landedCost":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string","minLength":3,"maxLength":3},"uom":{"type":"string"},"comparisonBasis":{"type":"string","enum":["material","landed","unclassified"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom","comparisonBasis"],"additionalProperties":false},"sourceDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"observedAt":{"type":"string","format":"date-time"},"status":{"type":"string","enum":["completed","pending"]},"sourceReference":{"type":"string","minLength":1}},"required":["materialCost","landedCost","sourceDate","observedAt","status","sourceReference"],"additionalProperties":false},"comparisons":{"type":"object","properties":{"currentVsPrior":{"type":"object","properties":{"left":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string","minLength":3,"maxLength":3},"uom":{"type":"string"},"comparisonBasis":{"type":"string","enum":["material","landed","unclassified"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom","comparisonBasis"],"additionalProperties":false},"right":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string","minLength":3,"maxLength":3},"uom":{"type":"string"},"comparisonBasis":{"type":"string","enum":["material","landed","unclassified"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom","comparisonBasis"],"additionalProperties":false},"comparable":{"type":"boolean"},"amountDeltaCentsPerBaseUom":{"type":["string","null"]},"percentageDelta":{"type":["string","null"]},"reason":{"type":["string","null"]},"temporalRelation":{"type":["string","null"],"enum":["evidence_precedes_cost_book_as_of","same_day_as_cost_book_as_of","evidence_postdates_cost_book_as_of"]}},"required":["left","right","comparable","amountDeltaCentsPerBaseUom","percentageDelta","reason","temporalRelation"],"additionalProperties":false},"currentVsCompleted":{"type":"object","properties":{"left":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string","minLength":3,"maxLength":3},"uom":{"type":"string"},"comparisonBasis":{"type":"string","enum":["material","landed","unclassified"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom","comparisonBasis"],"additionalProperties":false},"right":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string","minLength":3,"maxLength":3},"uom":{"type":"string"},"comparisonBasis":{"type":"string","enum":["material","landed","unclassified"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom","comparisonBasis"],"additionalProperties":false},"comparable":{"type":"boolean"},"amountDeltaCentsPerBaseUom":{"type":["string","null"]},"percentageDelta":{"type":["string","null"]},"reason":{"type":["string","null"]},"temporalRelation":{"type":["string","null"],"enum":["evidence_precedes_cost_book_as_of","same_day_as_cost_book_as_of","evidence_postdates_cost_book_as_of"]}},"required":["left","right","comparable","amountDeltaCentsPerBaseUom","percentageDelta","reason","temporalRelation"],"additionalProperties":false},"currentVsPending":{"type":"object","properties":{"left":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string","minLength":3,"maxLength":3},"uom":{"type":"string"},"comparisonBasis":{"type":"string","enum":["material","landed","unclassified"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom","comparisonBasis"],"additionalProperties":false},"right":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string","minLength":3,"maxLength":3},"uom":{"type":"string"},"comparisonBasis":{"type":"string","enum":["material","landed","unclassified"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom","comparisonBasis"],"additionalProperties":false},"comparable":{"type":"boolean"},"amountDeltaCentsPerBaseUom":{"type":["string","null"]},"percentageDelta":{"type":["string","null"]},"reason":{"type":["string","null"]},"temporalRelation":{"type":["string","null"],"enum":["evidence_precedes_cost_book_as_of","same_day_as_cost_book_as_of","evidence_postdates_cost_book_as_of"]}},"required":["left","right","comparable","amountDeltaCentsPerBaseUom","percentageDelta","reason","temporalRelation"],"additionalProperties":false}},"required":["currentVsPrior","currentVsCompleted","currentVsPending"],"additionalProperties":false},"expectedCurrentEntryId":{"type":["string","null"],"format":"uuid"},"completeness":{"type":"string","enum":["complete","partial","missing","unresolved"]},"warningCodes":{"type":"array","items":{"type":"string"}},"sourceSelection":{"type":"object","properties":{"resolutionMode":{"type":"string","enum":["explicit","fixed_supplier","current_source","only_available"]},"authorityState":{"type":["string","null"],"enum":["fixed_supplier","current_source","unconfigured","unavailable"]},"resolvedSupplierId":{"type":"string","format":"uuid"},"candidateCount":{"type":"integer","minimum":0},"candidates":{"type":"array","items":{"type":"object","properties":{"supplierId":{"type":"string","format":"uuid"},"supplierName":{"type":"string"},"evidenceSource":{"type":"string","enum":["active_book","construction"]}},"required":["supplierId","supplierName","evidenceSource"],"additionalProperties":false}},"selectionProvenance":{"type":["object","null"],"properties":{"selectedAt":{"type":"string"},"selectedById":{"type":"string","format":"uuid"},"selectedByName":{"type":"string"}},"required":["selectedAt","selectedById","selectedByName"],"additionalProperties":false},"unavailabilityReason":{"type":["string","null"]}},"required":["resolutionMode","authorityState","resolvedSupplierId","candidateCount","candidates","selectionProvenance","unavailabilityReason"],"additionalProperties":false}},"required":["product","supplier","costBookAsOf","purchaseEvidenceObservedAt","currencyCode","currentCostBookEntry","priorCostBookEntry","lastCompletedPurchase","latestOnOrderPurchase","comparisons","expectedCurrentEntryId","completeness","warningCodes","sourceSelection"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},"PublicAPIDocumentResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["document"]},"id":{"type":"string","format":"uuid"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"urlClass":{"type":"string","enum":["shelfcycle","external"]},"access":{"type":"object","properties":{"mode":{"type":"string","enum":["signed","raw","unavailable"]},"url":{"type":"string"},"expiresAt":{"type":"string","format":"date-time"}},"required":["mode"],"additionalProperties":false},"idempotencyStatus":{"type":"string","enum":["created","replayed"]},"integrity":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","enum":["verified"]},"checksumSha256":{"type":"string","pattern":"^[a-f0-9]{64}$","description":"Lowercase SHA-256 matched by the association-time storage HEAD check."},"sizeBytes":{"type":"integer","exclusiveMinimum":0,"description":"Storage-reported object size verified at association time."},"contentType":{"type":"string","minLength":1,"description":"Storage-reported canonical content type verified at association time."},"verifiedAt":{"type":"string","format":"date-time","description":"Time ShelfCycle completed the association verification."}},"required":["status","checksumSha256","sizeBytes","contentType","verifiedAt"],"additionalProperties":false,"description":"Durable association receipt; it is not malware scanning, content interpretation, or perpetual-retention proof."},{"type":"object","properties":{"status":{"type":"string","enum":["not_verified"]},"reason":{"type":"string","enum":["external_or_legacy_link"]}},"required":["status","reason"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","enum":["unavailable"]},"reason":{"type":"string","enum":["legacy_receipt_not_recorded"]}},"required":["status","reason"],"additionalProperties":false}]}},"required":["type","id","fileName","createdAt","urlClass","access","idempotencyStatus","integrity"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},"PublicAPIDocumentsResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"documents":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["document"]},"id":{"type":"string","format":"uuid"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"urlClass":{"type":"string","enum":["shelfcycle","external"]},"access":{"type":"object","properties":{"mode":{"type":"string","enum":["signed","raw","unavailable"]},"url":{"type":"string"},"expiresAt":{"type":"string","format":"date-time"}},"required":["mode"],"additionalProperties":false}},"required":["type","id","fileName","createdAt","urlClass","access"],"additionalProperties":false}},"truncated":{"type":"boolean"}},"required":["documents","truncated"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},"PublicAPIProductDocumentsResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"documents":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["document"]},"id":{"type":"string","format":"uuid"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"urlClass":{"type":"string","enum":["shelfcycle","external"]},"access":{"type":"object","properties":{"mode":{"type":"string","enum":["signed","raw","unavailable"]},"url":{"type":"string"},"expiresAt":{"type":"string","format":"date-time"}},"required":["mode"],"additionalProperties":false}},"required":["type","id","fileName","createdAt","urlClass","access"],"additionalProperties":false}},"truncated":{"type":"boolean"},"sds":{"type":["object","null"],"properties":{"fileName":{"type":"string"},"access":{"type":"object","properties":{"mode":{"type":"string","enum":["signed","raw","unavailable"]},"url":{"type":"string"},"expiresAt":{"type":"string","format":"date-time"}},"required":["mode"],"additionalProperties":false}},"required":["fileName","access"],"additionalProperties":false}},"required":["documents","truncated","sds"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},"PublicAPIDocumentUploadGrantResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["document_upload_grant"]},"id":{"type":"string","format":"uuid"},"upload":{"type":"object","properties":{"method":{"type":"string","enum":["PUT"]},"url":{"type":"string","format":"uri"},"headers":{"type":"object","properties":{"Content-Length":{"type":"string"},"Content-Type":{"type":"string"},"If-None-Match":{"type":"string","enum":["*"]},"x-amz-checksum-sha256":{"type":"string"}},"required":["Content-Length","Content-Type","If-None-Match","x-amz-checksum-sha256"],"additionalProperties":false},"expiresAt":{"type":"string","format":"date-time"}},"required":["method","url","headers","expiresAt"],"additionalProperties":false},"document":{"type":"object","properties":{"fileName":{"type":"string"},"url":{"type":"string","format":"uri"}},"required":["fileName","url"],"additionalProperties":false}},"required":["type","id","upload","document"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},"PublicAPIProductSDSResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["product_sds"]},"productId":{"type":"string","format":"uuid"},"fileName":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"},"idempotencyStatus":{"type":"string","enum":["updated","replayed","repaired"]}},"required":["type","productId","fileName","updatedAt","idempotencyStatus"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},"PublicAPISalesOrderDocumentResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"object":{"type":"string","enum":["sales_order"]},"id":{"type":"string","format":"uuid"},"url":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"},"header":{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time"},"createdBy":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["user"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["system"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string","enum":["System User"]}},"required":["type","id","displayName"],"additionalProperties":false}]},"orderNo":{"type":"string"},"externalId":{"type":["string","null"]},"type":{"type":"string"},"status":{"type":"string"},"customer":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"externalId":{"type":["string","null"]},"url":{"type":"string"}},"required":["id","displayName","externalId","url"],"additionalProperties":false},"linkedPurchaseOrder":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"orderNo":{"type":"string"},"url":{"type":"string"}},"required":["id","orderNo","url"],"additionalProperties":false},"shipTo":{"type":["object","null"],"properties":{"id":{"type":["string","null"],"format":"uuid"},"name":{"type":["string","null"]},"street1":{"type":["string","null"]},"street2":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"zip":{"type":["string","null"]},"country":{"type":["string","null"]}},"required":["id","name","street1","street2","city","state","zip","country"],"additionalProperties":false},"shippingInstructions":{"type":"string"},"customerOrderNo":{"type":["string","null"]},"orderedAt":{"type":["string","null"]},"shipBy":{"type":["string","null"]},"requiredBy":{"type":["string","null"]},"shippedAt":{"type":["string","null"]},"deliveredAt":{"type":["string","null"]},"assignedTo":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["id","displayName"],"additionalProperties":false},"warehouse":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["id","displayName"],"additionalProperties":false},"freightTerms":{"type":["string","null"]},"freightMethod":{"type":["string","null"]}},"required":["createdAt","createdBy","orderNo","externalId","type","status","customer","linkedPurchaseOrder","shipTo","shippingInstructions","customerOrderNo","orderedAt","shipBy","requiredBy","shippedAt","deliveredAt","assignedTo","warehouse","freightTerms","freightMethod"],"additionalProperties":false},"lineItems":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"lineType":{"type":"string","enum":["product","non_product"]},"description":{"type":"string"},"product":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"code":{"type":"string"},"displayName":{"type":"string"},"productFamily":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false}},"required":["id","code","displayName","productFamily"],"additionalProperties":false},"quantity":{"type":"string"},"productQuantity":{"type":["string","null"]},"uom":{"type":["string","null"]},"unitPriceCents":{"type":["string","null"]},"extendedAmountCents":{"type":"string"},"currency":{"type":"string","pattern":"^[A-Z]{3}$"},"fulfillment":{"type":"object","properties":{"consumedAt":{"type":["string","null"]},"allocated":{"type":"boolean"},"virtualInventory":{"type":"boolean"}},"required":["consumedAt","allocated","virtualInventory"],"additionalProperties":false}},"required":["id","lineType","description","product","quantity","productQuantity","uom","unitPriceCents","extendedAmountCents","currency","fulfillment"],"additionalProperties":false}},"totals":{"type":"object","properties":{"subtotalAmountCents":{"type":"string"},"taxAmountCents":{"type":"string"},"shippingAmountCents":{"type":"string"},"feeAmountCents":{"type":"string"},"totalAmountCents":{"type":"string"},"currency":{"type":"string","minLength":3,"maxLength":3}},"required":["subtotalAmountCents","taxAmountCents","shippingAmountCents","feeAmountCents","totalAmountCents","currency"],"additionalProperties":false},"lineCoverage":{"type":"object","properties":{"totalLines":{"type":"integer","minimum":0},"returnedLines":{"type":"integer","minimum":0},"hasMore":{"type":"boolean"},"nextLineCursor":{"type":["string","null"]}},"required":["totalLines","returnedLines","hasMore","nextLineCursor"],"additionalProperties":false}},"required":["object","id","url","updatedAt","header","lineItems","totals","lineCoverage"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},"PublicAPIPurchaseOrderDocumentResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"object":{"type":"string","enum":["purchase_order"]},"id":{"type":"string","format":"uuid"},"url":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"},"header":{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time"},"createdBy":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["user"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["system"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string","enum":["System User"]}},"required":["type","id","displayName"],"additionalProperties":false}]},"orderNo":{"type":"string"},"externalId":{"type":["string","null"]},"type":{"type":"string"},"status":{"type":"string"},"supplier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"externalId":{"type":["string","null"]},"url":{"type":"string"}},"required":["id","displayName","externalId","url"],"additionalProperties":false},"supplierInstructions":{"type":["string","null"]},"linkedSalesOrder":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"orderNo":{"type":"string"},"customerOrderNo":{"type":["string","null"]},"url":{"type":"string"}},"required":["id","orderNo","customerOrderNo","url"],"additionalProperties":false},"shipFrom":{"type":["object","null"],"properties":{"id":{"type":["string","null"],"format":"uuid"},"name":{"type":["string","null"]},"street1":{"type":["string","null"]},"street2":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"zip":{"type":["string","null"]},"country":{"type":["string","null"]}},"required":["id","name","street1","street2","city","state","zip","country"],"additionalProperties":false},"assignedTo":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["id","displayName"],"additionalProperties":false},"warehouse":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["id","displayName"],"additionalProperties":false},"submittedAt":{"type":["string","null"]},"confirmedAt":{"type":["string","null"]},"completedAt":{"type":["string","null"]},"fullyReceivedAt":{"type":["string","null"]},"shipAt":{"type":["string","null"]},"dueAt":{"type":["string","null"]},"freightTerms":{"type":["string","null"]},"shipVia":{"type":["string","null"]}},"required":["createdAt","createdBy","orderNo","externalId","type","status","supplier","supplierInstructions","linkedSalesOrder","shipFrom","assignedTo","warehouse","submittedAt","confirmedAt","completedAt","fullyReceivedAt","shipAt","dueAt","freightTerms","shipVia"],"additionalProperties":false},"lineItems":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"description":{"type":"string"},"product":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"code":{"type":"string"},"displayName":{"type":"string"},"productFamily":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false}},"required":["id","code","displayName","productFamily"],"additionalProperties":false},"quantity":{"type":"string"},"productQuantity":{"type":"string"},"uom":{"type":"string"},"unitCostCents":{"type":["string","null"]},"extendedAmountCents":{"type":"string"},"currency":{"type":"string","pattern":"^[A-Z]{3}$"},"receipt":{"type":"object","properties":{"receiptCount":{"type":"integer","minimum":0},"firstReceivedAt":{"type":["string","null"]},"lastReceivedAt":{"type":["string","null"]},"virtualInventory":{"type":"boolean"}},"required":["receiptCount","firstReceivedAt","lastReceivedAt","virtualInventory"],"additionalProperties":false}},"required":["id","description","product","quantity","productQuantity","uom","unitCostCents","extendedAmountCents","currency","receipt"],"additionalProperties":false}},"costs":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"description":{"type":"string"},"amountCents":{"type":"string"},"currency":{"type":"string","pattern":"^[A-Z]{3}$"},"linkedLineId":{"type":["string","null"],"format":"uuid"}},"required":["id","description","amountCents","currency","linkedLineId"],"additionalProperties":false}},"totals":{"type":"object","properties":{"itemsAmountCents":{"type":"string"},"costsAmountCents":{"type":"string","description":"The document's non-item total component. It uses stored standalone PO costs for ordinary documents and, when row-level comparable evidence is required, includes margin-participating PO cost contributors plus margin-participating linked sales-order costs billed by the PO supplier. itemsAmountCents + costsAmountCents equals totalAmountCents. This field does not reconcile against the costs array, which lists this supplier's own costs on a different basis."},"totalAmountCents":{"type":"string"},"currency":{"type":"string","minLength":3,"maxLength":3}},"required":["itemsAmountCents","costsAmountCents","totalAmountCents","currency"],"additionalProperties":false},"lineCoverage":{"type":"object","properties":{"totalLines":{"type":"integer","minimum":0},"returnedLines":{"type":"integer","minimum":0},"hasMore":{"type":"boolean"},"nextLineCursor":{"type":["string","null"]}},"required":["totalLines","returnedLines","hasMore","nextLineCursor"],"additionalProperties":false}},"required":["object","id","url","updatedAt","header","lineItems","costs","totals","lineCoverage"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},"PublicAPIReportCatalogResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"reports":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","enum":["sales-summary","purchase-summary","open-sales-orders","ap-aging","payments-received","payments-made","ar-aging","pipeline-summary","customer-invoice-settlement-behavior","customer-credit-exposure","customer-invoice-charges"]},"title":{"type":"string"},"description":{"type":"string"},"params":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"required":{"type":"boolean"},"description":{"type":"string"},"values":{"type":"array","items":{"type":"string"}},"defaultValue":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}}]}},"required":["name","required","description"],"additionalProperties":false}},"dimensions":{"type":"array","items":{"type":"string"}},"measures":{"type":"array","items":{"type":"string"}},"requiredScope":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]},"requiredScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"allowedForThisKey":{"type":"boolean"}},"required":["key","title","description","params","dimensions","measures","requiredScope","allowedForThisKey"],"additionalProperties":false}}},"required":["reports"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},"PublicAPIReportRunResponse":{"anyOf":[{"type":"object","properties":{"data":{"type":"object","properties":{"params":{"type":"object","properties":{"counterpartyId":{"type":["string","null"],"format":"uuid","default":null},"transactionCurrencyCode":{"type":["string","null"],"pattern":"^[A-Z]{3}$","default":null},"dueBy":{"type":["string","null"],"pattern":"^\\d{4}-\\d{2}-\\d{2}$","default":null},"limit":{"type":"integer","minimum":1,"maximum":500,"default":100},"offset":{"type":"integer","minimum":0,"maximum":10000,"default":0},"sortBy":{"type":"string","enum":["netCents","openDocumentCents","pastDueDocumentCents","over365Cents","days90PlusCents","dueByCents","oldestDaysPastDue"],"default":"netCents"},"sortDirection":{"type":"string","enum":["asc","desc"],"default":"desc"}},"additionalProperties":false},"basis":{"type":"object","properties":{"dateBasis":{"type":"string","enum":["current-org-calendar-day"]},"timezone":{"type":"string"},"asOfDate":{"type":"string"},"generatedAt":{"type":"string"},"baseCurrencyCode":{"type":"string"},"accountingCutoverDay":{"type":["string","null"]},"coverageStartDate":{"type":["string","null"]},"historyState":{"type":"string","enum":["certified","preview","unverified_configuration_gap"]},"creditsIncluded":{"type":"boolean"},"currencyLaneNote":{"type":"string","enum":["transaction_currency_lanes"]},"paymentBehaviorBasis":{"type":["object","null"],"properties":{"observation":{"type":"string"},"learningWindow":{"type":"string"},"usualDaysLate":{"type":"string"},"recentDaysLate":{"type":"string"},"averageDaysToPay":{"type":"string"},"lastPaymentDate":{"type":"string"},"olderDueOpenCents":{"type":"string"},"olderDuePaidInWindowCents":{"type":"string"}},"required":["observation","learningWindow","usualDaysLate","recentDaysLate","averageDaysToPay","lastPaymentDate","olderDueOpenCents","olderDuePaidInWindowCents"],"additionalProperties":false},"notes":{"type":"array","items":{"type":"string"}}},"required":["dateBasis","timezone","asOfDate","generatedAt","baseCurrencyCode","accountingCutoverDay","coverageStartDate","historyState","creditsIncluded","currencyLaneNote","paymentBehaviorBasis","notes"],"additionalProperties":false},"rows":{"type":"array","items":{"type":"object","properties":{"transactionCurrencyCode":{"type":"string"},"openDocumentCents":{"type":"string","pattern":"^-?\\d+$"},"openCreditCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"netCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"pastDueDocumentCents":{"type":"string","pattern":"^-?\\d+$"},"currentCents":{"type":"string","pattern":"^-?\\d+$"},"days1To30Cents":{"type":"string","pattern":"^-?\\d+$"},"days31To60Cents":{"type":"string","pattern":"^-?\\d+$"},"days61To90Cents":{"type":"string","pattern":"^-?\\d+$"},"days90PlusCents":{"type":"string","pattern":"^-?\\d+$"},"over365Cents":{"type":"string","pattern":"^-?\\d+$"},"unknownCents":{"type":"string","pattern":"^-?\\d+$"},"dueByCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"openingAmountCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"openingDocumentCount":{"type":"integer","minimum":0},"openDocumentCount":{"type":"integer","minimum":0},"pastDueDocumentCount":{"type":"integer","minimum":0},"unknownDueDocumentCount":{"type":"integer","minimum":0},"openCreditCount":{"type":["integer","null"],"minimum":0},"counterpartyId":{"type":"string","format":"uuid"},"counterpartyName":{"type":"string"},"counterpartyStatus":{"type":"string","enum":["active","prospect","archived"]},"oldestDueDate":{"type":["string","null"]},"oldestDaysPastDue":{"type":["integer","null"],"minimum":0},"paymentBehavior":{"type":["object","null"],"properties":{"lastPaymentDate":{"type":["string","null"]},"usualDaysLate":{"type":["number","null"],"description":"Median final cash day minus due day across eligible documents in the learning window."},"recentDaysLate":{"type":["number","null"],"description":"Median final cash day minus due day across eligible documents settled in the last 90 days within that window."},"averageDaysToPay":{"type":["number","null"],"description":"Arithmetic mean final cash day minus document day across eligible documents in the learning window."},"nativePaidDocumentCount":{"type":"integer"},"settledOtherwiseCount":{"type":"integer"},"olderDueOpenCents":{"type":"string"},"olderDuePaidInWindowCents":{"type":["string","null"]},"olderDueCreditInWindowCents":{"type":["string","null"]},"olderDueAdjustmentInWindowCents":{"type":["string","null"]},"cashUnavailableCount":{"type":"integer"},"crossCurrencyCashCount":{"type":"integer"},"coverageStartDate":{"type":["string","null"]},"cashUnavailableReason":{"type":["string","null"],"enum":["legacy_mixed_cash_and_credit","mixed_cash_and_credit_attribution_unrecorded","cross_currency_cash"]}},"required":["lastPaymentDate","usualDaysLate","recentDaysLate","averageDaysToPay","nativePaidDocumentCount","settledOtherwiseCount","olderDueOpenCents","olderDuePaidInWindowCents","olderDueCreditInWindowCents","olderDueAdjustmentInWindowCents","cashUnavailableCount","crossCurrencyCashCount","coverageStartDate","cashUnavailableReason"],"additionalProperties":false}},"required":["transactionCurrencyCode","openDocumentCents","openCreditCents","netCents","pastDueDocumentCents","currentCents","days1To30Cents","days31To60Cents","days61To90Cents","days90PlusCents","over365Cents","unknownCents","dueByCents","openingAmountCents","openingDocumentCount","openDocumentCount","pastDueDocumentCount","unknownDueDocumentCount","openCreditCount","counterpartyId","counterpartyName","counterpartyStatus","oldestDueDate","oldestDaysPastDue","paymentBehavior"],"additionalProperties":false}},"totals":{"type":"object","properties":{"scope":{"type":"string","enum":["filtered-population-before-pagination"]},"byTransactionCurrency":{"type":"array","items":{"type":"object","properties":{"transactionCurrencyCode":{"type":"string"},"openDocumentCents":{"type":"string","pattern":"^-?\\d+$"},"openCreditCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"netCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"pastDueDocumentCents":{"type":"string","pattern":"^-?\\d+$"},"currentCents":{"type":"string","pattern":"^-?\\d+$"},"days1To30Cents":{"type":"string","pattern":"^-?\\d+$"},"days31To60Cents":{"type":"string","pattern":"^-?\\d+$"},"days61To90Cents":{"type":"string","pattern":"^-?\\d+$"},"days90PlusCents":{"type":"string","pattern":"^-?\\d+$"},"over365Cents":{"type":"string","pattern":"^-?\\d+$"},"unknownCents":{"type":"string","pattern":"^-?\\d+$"},"dueByCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"openingAmountCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"openingDocumentCount":{"type":"integer","minimum":0},"openDocumentCount":{"type":"integer","minimum":0},"pastDueDocumentCount":{"type":"integer","minimum":0},"unknownDueDocumentCount":{"type":"integer","minimum":0},"openCreditCount":{"type":["integer","null"],"minimum":0}},"required":["transactionCurrencyCode","openDocumentCents","openCreditCents","netCents","pastDueDocumentCents","currentCents","days1To30Cents","days31To60Cents","days61To90Cents","days90PlusCents","over365Cents","unknownCents","dueByCents","openingAmountCents","openingDocumentCount","openDocumentCount","pastDueDocumentCount","unknownDueDocumentCount","openCreditCount"],"additionalProperties":false}},"baseCurrencyCode":{"type":"string"},"baseOpenDocumentCents":{"type":"string","pattern":"^-?\\d+$"},"baseOpenCreditCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"baseNetCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"openingBaseAmountCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"openingDocumentCount":{"type":"integer","minimum":0}},"required":["scope","byTransactionCurrency","baseCurrencyCode","baseOpenDocumentCents","baseOpenCreditCents","baseNetCents","openingBaseAmountCents","openingDocumentCount"],"additionalProperties":false},"drafts":{"type":"object","properties":{"count":{"type":"integer","minimum":0},"byTransactionCurrency":{"type":"array","items":{"type":"object","properties":{"transactionCurrencyCode":{"type":"string"},"count":{"type":"integer","minimum":0},"amountCents":{"type":"string","pattern":"^-?\\d+$"}},"required":["transactionCurrencyCode","count","amountCents"],"additionalProperties":false}}},"required":["count","byTransactionCurrency"],"additionalProperties":false},"paymentsBeingPrepared":{"type":["object","null"],"properties":{"scope":{"type":"string","enum":["organization","supplier"]},"batchCount":{"type":"integer","minimum":0},"oldestCreatedDate":{"type":["string","null"]},"byTransactionCurrency":{"type":"array","items":{"type":"object","properties":{"transactionCurrencyCode":{"type":"string"},"count":{"type":"integer","minimum":0},"amountCents":{"type":"string","pattern":"^-?\\d+$"}},"required":["transactionCurrencyCode","count","amountCents"],"additionalProperties":false}}},"required":["scope","batchCount","oldestCreatedDate","byTransactionCurrency"],"additionalProperties":false},"hygieneFacts":{"type":"array","items":{"type":"object","properties":{"counterpartyStatus":{"type":"string","enum":["archived","prospect"]},"transactionCurrencyCode":{"type":"string"},"counterpartyCount":{"type":"integer","minimum":0},"openDocumentCents":{"type":"string","pattern":"^-?\\d+$"}},"required":["counterpartyStatus","transactionCurrencyCode","counterpartyCount","openDocumentCents"],"additionalProperties":false}},"meta":{"type":"object","properties":{"totalGroups":{"type":"integer","minimum":0},"returnedGroups":{"type":"integer","minimum":0},"truncated":{"type":"boolean"},"limit":{"type":"integer","minimum":0},"offset":{"type":"integer","minimum":0},"ordering":{"type":"string"},"rankingComplete":{"type":"boolean","enum":[true]},"populationDiagnostics":{"type":"object","properties":{"negativeDueCount":{"type":"integer","minimum":0},"paidWithDueCount":{"type":"integer","minimum":0},"postedZeroDueCount":{"type":"integer","minimum":0},"creditIncoherentCount":{"type":["integer","null"],"minimum":0},"zeroPaidPartialCount":{"type":"integer","minimum":0}},"required":["negativeDueCount","paidWithDueCount","postedZeroDueCount","creditIncoherentCount","zeroPaidPartialCount"],"additionalProperties":false}},"required":["totalGroups","returnedGroups","truncated","limit","offset","ordering","rankingComplete","populationDiagnostics"],"additionalProperties":false},"report":{"type":"object","properties":{"key":{"type":"string","enum":["ap-aging"]},"title":{"type":"string"},"description":{"type":"string"},"params":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"required":{"type":"boolean"},"description":{"type":"string"},"values":{"type":"array","items":{"type":"string"}},"defaultValue":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}}]}},"required":["name","required","description"],"additionalProperties":false}},"dimensions":{"type":"array","items":{"type":"string"}},"measures":{"type":"array","items":{"type":"string"}},"requiredScope":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]},"requiredScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"allowedForThisKey":{"type":"boolean"}},"required":["key","title","description","params","dimensions","measures","requiredScope","allowedForThisKey"],"additionalProperties":false}},"required":["params","basis","rows","totals","drafts","paymentsBeingPrepared","hygieneFacts","meta","report"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"params":{"type":"object","properties":{"from":{"type":["string","null"],"pattern":"^\\d{4}-\\d{2}-\\d{2}$","default":null},"to":{"type":["string","null"],"pattern":"^\\d{4}-\\d{2}-\\d{2}$","default":null},"includeOpeningDocuments":{"type":"boolean","default":false},"counterpartyId":{"type":["string","null"],"format":"uuid","default":null},"transactionCurrencyCode":{"type":["string","null"],"pattern":"^[A-Z]{3}$","default":null},"groupBy":{"type":"string","enum":["counterparty","month"],"default":"counterparty"},"limit":{"type":"integer","minimum":1,"maximum":500,"default":100},"offset":{"type":"integer","minimum":0,"maximum":10000,"default":0}},"additionalProperties":false},"basis":{"type":"object","properties":{"timezone":{"type":"string"},"baseCurrencyCode":{"type":"string"},"accountingCutoverDay":{"type":["string","null"]},"coverageStartDate":{"type":["string","null"]},"effectiveWindow":{"type":"object","properties":{"from":{"type":"string"},"to":{"type":"string"}},"required":["from","to"],"additionalProperties":false},"dateBasis":{"type":"string","enum":["payment date","posted batch date"]},"documentDateBasis":{"type":"string","enum":["posted date"]},"documentAmountsIncluded":{"type":"boolean"},"currencyLaneNote":{"type":"string","enum":["transaction_currency_lanes"]},"historyState":{"type":"string","enum":["certified","preview","unverified_configuration_gap"]}},"required":["timezone","baseCurrencyCode","accountingCutoverDay","coverageStartDate","effectiveWindow","dateBasis","documentDateBasis","documentAmountsIncluded","currencyLaneNote","historyState"],"additionalProperties":false},"rows":{"type":"array","items":{"type":"object","properties":{"transactionCurrencyCode":{"type":"string"},"paymentCount":{"type":"integer"},"cashAmountCents":{"type":"string","pattern":"^-?\\d+$"},"adjustmentCents":{"type":"string","pattern":"^-?\\d+$"},"documentCount":{"type":["integer","null"]},"documentAmountCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"keptOnAccountCents":{"type":"string","pattern":"^-?\\d+$"},"appliedAmountCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"unavailableAllocationCount":{"type":["integer","null"]},"appliedAmountUnavailableReason":{"type":["string","null"],"enum":["allocation_cash_unproven","invoice_permission_withheld"]},"counterpartyId":{"type":["string","null"],"format":"uuid"},"counterpartyName":{"type":["string","null"]},"counterpartyStatus":{"type":["string","null"]},"month":{"type":["string","null"]}},"required":["transactionCurrencyCode","paymentCount","cashAmountCents","adjustmentCents","documentCount","documentAmountCents","keptOnAccountCents","appliedAmountCents","unavailableAllocationCount","appliedAmountUnavailableReason","counterpartyId","counterpartyName","counterpartyStatus","month"],"additionalProperties":false}},"totals":{"type":"object","properties":{"scope":{"type":"string","enum":["filtered-population-before-pagination"]},"byTransactionCurrency":{"type":"array","items":{"type":"object","properties":{"transactionCurrencyCode":{"type":"string"},"paymentCount":{"type":"integer"},"cashAmountCents":{"type":"string","pattern":"^-?\\d+$"},"adjustmentCents":{"type":"string","pattern":"^-?\\d+$"},"documentCount":{"type":["integer","null"]},"documentAmountCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"keptOnAccountCents":{"type":"string","pattern":"^-?\\d+$"},"appliedAmountCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"unavailableAllocationCount":{"type":["integer","null"]},"appliedAmountUnavailableReason":{"type":["string","null"],"enum":["allocation_cash_unproven","invoice_permission_withheld"]}},"required":["transactionCurrencyCode","paymentCount","cashAmountCents","adjustmentCents","documentCount","documentAmountCents","keptOnAccountCents","appliedAmountCents","unavailableAllocationCount","appliedAmountUnavailableReason"],"additionalProperties":false}},"baseCurrencyCode":{"type":"string"},"baseCashAmountCents":{"type":"string","pattern":"^-?\\d+$"},"paymentCount":{"type":"integer"}},"required":["scope","byTransactionCurrency","baseCurrencyCode","baseCashAmountCents","paymentCount"],"additionalProperties":false},"meta":{"type":"object","properties":{"totalGroups":{"type":"integer"},"returnedGroups":{"type":"integer"},"truncated":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"ordering":{"type":"string"},"rankingComplete":{"type":"boolean","enum":[true]}},"required":["totalGroups","returnedGroups","truncated","limit","offset","ordering","rankingComplete"],"additionalProperties":false},"report":{"type":"object","properties":{"key":{"type":"string","enum":["payments-received"]},"title":{"type":"string"},"description":{"type":"string"},"params":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"required":{"type":"boolean"},"description":{"type":"string"},"values":{"type":"array","items":{"type":"string"}},"defaultValue":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}}]}},"required":["name","required","description"],"additionalProperties":false}},"dimensions":{"type":"array","items":{"type":"string"}},"measures":{"type":"array","items":{"type":"string"}},"requiredScope":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]},"requiredScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"allowedForThisKey":{"type":"boolean"}},"required":["key","title","description","params","dimensions","measures","requiredScope","allowedForThisKey"],"additionalProperties":false}},"required":["params","basis","rows","totals","meta","report"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"params":{"type":"object","properties":{"from":{"type":["string","null"],"pattern":"^\\d{4}-\\d{2}-\\d{2}$","default":null},"to":{"type":["string","null"],"pattern":"^\\d{4}-\\d{2}-\\d{2}$","default":null},"includeOpeningDocuments":{"type":"boolean","default":false},"counterpartyId":{"type":["string","null"],"format":"uuid","default":null},"transactionCurrencyCode":{"type":["string","null"],"pattern":"^[A-Z]{3}$","default":null},"groupBy":{"type":"string","enum":["counterparty","month"],"default":"counterparty"},"limit":{"type":"integer","minimum":1,"maximum":500,"default":100},"offset":{"type":"integer","minimum":0,"maximum":10000,"default":0}},"additionalProperties":false},"basis":{"type":"object","properties":{"timezone":{"type":"string"},"baseCurrencyCode":{"type":"string"},"accountingCutoverDay":{"type":["string","null"]},"coverageStartDate":{"type":["string","null"]},"effectiveWindow":{"type":"object","properties":{"from":{"type":"string"},"to":{"type":"string"}},"required":["from","to"],"additionalProperties":false},"dateBasis":{"type":"string","enum":["payment date","posted batch date"]},"documentDateBasis":{"type":"string","enum":["posted date"]},"documentAmountsIncluded":{"type":"boolean"},"currencyLaneNote":{"type":"string","enum":["transaction_currency_lanes"]},"historyState":{"type":"string","enum":["certified","preview","unverified_configuration_gap"]}},"required":["timezone","baseCurrencyCode","accountingCutoverDay","coverageStartDate","effectiveWindow","dateBasis","documentDateBasis","documentAmountsIncluded","currencyLaneNote","historyState"],"additionalProperties":false},"rows":{"type":"array","items":{"type":"object","properties":{"transactionCurrencyCode":{"type":"string"},"paymentCount":{"type":"integer"},"cashAmountCents":{"type":"string","pattern":"^-?\\d+$"},"adjustmentCents":{"type":"string","pattern":"^-?\\d+$"},"documentCount":{"type":["integer","null"]},"documentAmountCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"counterpartyId":{"type":["string","null"],"format":"uuid"},"counterpartyName":{"type":["string","null"]},"counterpartyStatus":{"type":["string","null"]},"month":{"type":["string","null"]}},"required":["transactionCurrencyCode","paymentCount","cashAmountCents","adjustmentCents","documentCount","documentAmountCents","counterpartyId","counterpartyName","counterpartyStatus","month"],"additionalProperties":false}},"totals":{"type":"object","properties":{"scope":{"type":"string","enum":["filtered-population-before-pagination"]},"byTransactionCurrency":{"type":"array","items":{"type":"object","properties":{"transactionCurrencyCode":{"type":"string"},"paymentCount":{"type":"integer"},"cashAmountCents":{"type":"string","pattern":"^-?\\d+$"},"adjustmentCents":{"type":"string","pattern":"^-?\\d+$"},"documentCount":{"type":["integer","null"]},"documentAmountCents":{"type":["string","null"],"pattern":"^-?\\d+$"}},"required":["transactionCurrencyCode","paymentCount","cashAmountCents","adjustmentCents","documentCount","documentAmountCents"],"additionalProperties":false}},"baseCurrencyCode":{"type":"string"},"baseCashAmountCents":{"type":"string","pattern":"^-?\\d+$"},"paymentCount":{"type":"integer"}},"required":["scope","byTransactionCurrency","baseCurrencyCode","baseCashAmountCents","paymentCount"],"additionalProperties":false},"meta":{"type":"object","properties":{"totalGroups":{"type":"integer"},"returnedGroups":{"type":"integer"},"truncated":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"ordering":{"type":"string"},"rankingComplete":{"type":"boolean","enum":[true]}},"required":["totalGroups","returnedGroups","truncated","limit","offset","ordering","rankingComplete"],"additionalProperties":false},"report":{"type":"object","properties":{"key":{"type":"string","enum":["payments-made"]},"title":{"type":"string"},"description":{"type":"string"},"params":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"required":{"type":"boolean"},"description":{"type":"string"},"values":{"type":"array","items":{"type":"string"}},"defaultValue":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}}]}},"required":["name","required","description"],"additionalProperties":false}},"dimensions":{"type":"array","items":{"type":"string"}},"measures":{"type":"array","items":{"type":"string"}},"requiredScope":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]},"requiredScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"allowedForThisKey":{"type":"boolean"}},"required":["key","title","description","params","dimensions","measures","requiredScope","allowedForThisKey"],"additionalProperties":false}},"required":["params","basis","rows","totals","meta","report"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"report":{"type":"object","properties":{"key":{"type":"string","enum":["sales-summary"]},"title":{"type":"string"},"description":{"type":"string"},"params":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"required":{"type":"boolean"},"description":{"type":"string"},"values":{"type":"array","items":{"type":"string"}},"defaultValue":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}}]}},"required":["name","required","description"],"additionalProperties":false}},"dimensions":{"type":"array","items":{"type":"string"}},"measures":{"type":"array","items":{"type":"string"}},"requiredScope":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]},"requiredScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"allowedForThisKey":{"type":"boolean"}},"required":["key","title","description","params","dimensions","measures","requiredScope","allowedForThisKey"],"additionalProperties":false},"params":{"type":"object","additionalProperties":{}},"basis":{"type":"object","properties":{"dateBasis":{"type":"string"},"timezone":{"type":"string"},"currencyMode":{"type":"string","enum":["org-base"]},"generatedAt":{"type":"string","format":"date-time"},"startDate":{"type":"string"},"endDate":{"type":"string"},"statusesRequested":{"type":"array","items":{"type":"string"}},"statusesEffective":{"type":"array","items":{"type":"string"}},"lineType":{"type":"string"},"rowsConsidered":{"type":"integer"},"fetchWindow":{"type":"object","properties":{"start":{"type":["string","null"]},"end":{"type":["string","null"]}},"required":["start","end"],"additionalProperties":false},"largeWindow":{"type":"boolean"},"primaryWindow":{"type":"object","properties":{"startDate":{"type":"string"},"endDate":{"type":"string"},"rowsConsidered":{"type":"integer"}},"required":["startDate","endDate","rowsConsidered"],"additionalProperties":false},"comparisonWindow":{"type":"object","properties":{"startDate":{"type":"string"},"endDate":{"type":"string"},"rowsConsidered":{"type":"integer"}},"required":["startDate","endDate","rowsConsidered"],"additionalProperties":false},"notes":{"type":"array","items":{"type":"string"}}},"required":["dateBasis","timezone","currencyMode","generatedAt","notes"],"additionalProperties":false},"rows":{"type":"array","items":{"type":"object","properties":{"groupId":{"type":["string","null"],"format":"uuid"},"bucketKey":{"type":"string"},"groupName":{"type":"string"},"group2Id":{"type":["string","null"],"format":"uuid"},"group2Key":{"type":"string"},"group2Name":{"type":"string"},"salesCents":{"type":"string"},"productCostCents":{"type":"string"},"orderCostsCents":{"type":"string","description":"Fulfillment cost allocated to the group, in org-base cents as a decimal string, net of recovered pass-through. Product rows carry residual burden after mapped charge recovery; charge rows carry consumed recovery for their class (unmapped charges carry 0). Governed by the organization's live fulfillment mappings."},"totalCostCents":{"type":"string"},"gpCents":{"type":"string","description":"Gross profit in org-base cents as a decimal string: salesCents minus totalCostCents. totalCostCents uses net-of-recovery orderCostsCents, so gpCents is delivered margin at row grain and still sums to the order total when every marginable line is in the window."},"gpPct":{"type":["number","null"],"description":"Gross profit percent from returned cents. Null when salesCents <= 0. Charge-line groups do not expose a margin percent; product-row percent is residual burden over product revenue, which can differ from order-level GP % of invoice total until those denominators are unified."},"qty":{"type":"number"},"volumeLbs":{"type":["number","null"]},"orderCount":{"type":"integer"},"itemCount":{"type":"integer"},"firstDate":{"type":["string","null"]},"lastDate":{"type":["string","null"]},"unitPrice":{"type":"object","properties":{"avgUnitPriceCents":{"type":"string"},"lastUnitPriceCents":{"type":["string","null"]},"uom":{"type":"string"}},"required":["avgUnitPriceCents","lastUnitPriceCents","uom"],"additionalProperties":false},"comparison":{"type":"object","properties":{"salesCents":{"type":"string"},"productCostCents":{"type":"string"},"orderCostsCents":{"type":"string","description":"Fulfillment cost allocated to the group, in org-base cents as a decimal string, net of recovered pass-through. Product rows carry residual burden after mapped charge recovery; charge rows carry consumed recovery for their class (unmapped charges carry 0). Governed by the organization's live fulfillment mappings."},"totalCostCents":{"type":"string"},"gpCents":{"type":"string","description":"Gross profit in org-base cents as a decimal string: salesCents minus totalCostCents. totalCostCents uses net-of-recovery orderCostsCents, so gpCents is delivered margin at row grain and still sums to the order total when every marginable line is in the window."},"gpPct":{"type":["number","null"],"description":"Gross profit percent from returned cents. Null when salesCents <= 0. Charge-line groups do not expose a margin percent; product-row percent is residual burden over product revenue, which can differ from order-level GP % of invoice total until those denominators are unified."},"qty":{"type":"number"},"volumeLbs":{"type":["number","null"]},"orderCount":{"type":"integer"},"itemCount":{"type":"integer"},"firstDate":{"type":["string","null"]},"lastDate":{"type":["string","null"]}},"required":["salesCents","productCostCents","orderCostsCents","totalCostCents","gpCents","gpPct","qty","volumeLbs","orderCount","itemCount","firstDate","lastDate"],"additionalProperties":false},"deltas":{"type":"object","properties":{"salesCents":{"type":"string"},"productCostCents":{"type":"string"},"orderCostsCents":{"type":"string","description":"Fulfillment cost allocated to the group, in org-base cents as a decimal string, net of recovered pass-through. Product rows carry residual burden after mapped charge recovery; charge rows carry consumed recovery for their class (unmapped charges carry 0). Governed by the organization's live fulfillment mappings."},"totalCostCents":{"type":"string"},"gpCents":{"type":"string","description":"Gross profit in org-base cents as a decimal string: salesCents minus totalCostCents. totalCostCents uses net-of-recovery orderCostsCents, so gpCents is delivered margin at row grain and still sums to the order total when every marginable line is in the window."},"qty":{"type":"number"},"volumeLbs":{"type":["number","null"]},"orderCount":{"type":"integer"},"itemCount":{"type":"integer"},"gpPctPoints":{"type":["number","null"]}},"required":["salesCents","productCostCents","orderCostsCents","totalCostCents","gpCents","qty","volumeLbs","orderCount","itemCount","gpPctPoints"],"additionalProperties":false},"comparisonClassification":{"type":"string","enum":["new","lost","retained"]}},"required":["groupId","bucketKey","groupName","salesCents","productCostCents","orderCostsCents","totalCostCents","gpCents","gpPct","qty","volumeLbs","orderCount","itemCount","firstDate","lastDate"],"additionalProperties":false}},"totals":{"type":"object","properties":{"scope":{"type":"string","enum":["filtered-population-before-pagination"]},"primary":{"type":"object","properties":{"salesCents":{"type":"string"},"productCostCents":{"type":"string"},"orderCostsCents":{"type":"string","description":"Fulfillment cost allocated to the group, in org-base cents as a decimal string, net of recovered pass-through. Product rows carry residual burden after mapped charge recovery; charge rows carry consumed recovery for their class (unmapped charges carry 0). Governed by the organization's live fulfillment mappings."},"totalCostCents":{"type":"string"},"gpCents":{"type":"string","description":"Gross profit in org-base cents as a decimal string: salesCents minus totalCostCents. totalCostCents uses net-of-recovery orderCostsCents, so gpCents is delivered margin at row grain and still sums to the order total when every marginable line is in the window."},"gpPct":{"type":["number","null"],"description":"Gross profit percent from returned cents. Null when salesCents <= 0. Charge-line groups do not expose a margin percent; product-row percent is residual burden over product revenue, which can differ from order-level GP % of invoice total until those denominators are unified."},"qty":{"type":"number"},"volumeLbs":{"type":["number","null"]},"itemCount":{"type":"integer"}},"required":["salesCents","productCostCents","orderCostsCents","totalCostCents","gpCents","gpPct","qty","volumeLbs","itemCount"],"additionalProperties":false},"comparison":{"type":"object","properties":{"salesCents":{"type":"string"},"productCostCents":{"type":"string"},"orderCostsCents":{"type":"string","description":"Fulfillment cost allocated to the group, in org-base cents as a decimal string, net of recovered pass-through. Product rows carry residual burden after mapped charge recovery; charge rows carry consumed recovery for their class (unmapped charges carry 0). Governed by the organization's live fulfillment mappings."},"totalCostCents":{"type":"string"},"gpCents":{"type":"string","description":"Gross profit in org-base cents as a decimal string: salesCents minus totalCostCents. totalCostCents uses net-of-recovery orderCostsCents, so gpCents is delivered margin at row grain and still sums to the order total when every marginable line is in the window."},"gpPct":{"type":["number","null"],"description":"Gross profit percent from returned cents. Null when salesCents <= 0. Charge-line groups do not expose a margin percent; product-row percent is residual burden over product revenue, which can differ from order-level GP % of invoice total until those denominators are unified."},"qty":{"type":"number"},"volumeLbs":{"type":["number","null"]},"itemCount":{"type":"integer"}},"required":["salesCents","productCostCents","orderCostsCents","totalCostCents","gpCents","gpPct","qty","volumeLbs","itemCount"],"additionalProperties":false},"deltas":{"type":"object","properties":{"salesCents":{"type":"string"},"productCostCents":{"type":"string"},"orderCostsCents":{"type":"string","description":"Fulfillment cost allocated to the group, in org-base cents as a decimal string, net of recovered pass-through. Product rows carry residual burden after mapped charge recovery; charge rows carry consumed recovery for their class (unmapped charges carry 0). Governed by the organization's live fulfillment mappings."},"totalCostCents":{"type":"string"},"gpCents":{"type":"string","description":"Gross profit in org-base cents as a decimal string: salesCents minus totalCostCents. totalCostCents uses net-of-recovery orderCostsCents, so gpCents is delivered margin at row grain and still sums to the order total when every marginable line is in the window."},"qty":{"type":"number"},"volumeLbs":{"type":["number","null"]},"itemCount":{"type":"integer"},"gpPctPoints":{"type":["number","null"]}},"required":["salesCents","productCostCents","orderCostsCents","totalCostCents","gpCents","qty","volumeLbs","itemCount","gpPctPoints"],"additionalProperties":false}},"required":["scope","primary"],"additionalProperties":false},"meta":{"type":"object","properties":{"totalGroups":{"type":"integer"},"returnedGroups":{"type":"integer"},"truncated":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"ordering":{"type":"string"},"hasMoreAfterPage":{"type":"boolean"},"rowsCoverFullPopulation":{"type":"boolean"},"rankingComplete":{"type":"boolean"},"sortBy":{"type":"string"},"sortDirection":{"type":"string","enum":["asc","desc"]}},"required":["totalGroups","returnedGroups","truncated","limit","offset","ordering","rowsCoverFullPopulation","rankingComplete"],"additionalProperties":false}},"required":["report","params","basis","rows","totals","meta"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"report":{"type":"object","properties":{"key":{"type":"string","enum":["purchase-summary"]},"title":{"type":"string"},"description":{"type":"string"},"params":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"required":{"type":"boolean"},"description":{"type":"string"},"values":{"type":"array","items":{"type":"string"}},"defaultValue":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}}]}},"required":["name","required","description"],"additionalProperties":false}},"dimensions":{"type":"array","items":{"type":"string"}},"measures":{"type":"array","items":{"type":"string"}},"requiredScope":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]},"requiredScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"allowedForThisKey":{"type":"boolean"}},"required":["key","title","description","params","dimensions","measures","requiredScope","allowedForThisKey"],"additionalProperties":false},"params":{"type":"object","additionalProperties":{}},"basis":{"type":"object","properties":{"dateBasis":{"type":"string"},"timezone":{"type":"string"},"currencyMode":{"type":"string","enum":["org-base"]},"generatedAt":{"type":"string","format":"date-time"},"startDate":{"type":"string"},"endDate":{"type":"string"},"statusesRequested":{"type":"array","items":{"type":"string"}},"statusesEffective":{"type":"array","items":{"type":"string"}},"lineType":{"type":"string"},"rowsConsidered":{"type":"integer"},"fetchWindow":{"type":"object","properties":{"start":{"type":["string","null"]},"end":{"type":["string","null"]}},"required":["start","end"],"additionalProperties":false},"largeWindow":{"type":"boolean"},"primaryWindow":{"type":"object","properties":{"startDate":{"type":"string"},"endDate":{"type":"string"},"rowsConsidered":{"type":"integer"}},"required":["startDate","endDate","rowsConsidered"],"additionalProperties":false},"comparisonWindow":{"type":"object","properties":{"startDate":{"type":"string"},"endDate":{"type":"string"},"rowsConsidered":{"type":"integer"}},"required":["startDate","endDate","rowsConsidered"],"additionalProperties":false},"notes":{"type":"array","items":{"type":"string"}}},"required":["dateBasis","timezone","currencyMode","generatedAt","notes"],"additionalProperties":false},"rows":{"type":"array","items":{"type":"object","properties":{"groupId":{"type":["string","null"],"format":"uuid"},"bucketKey":{"type":"string"},"groupName":{"type":"string"},"group2Id":{"type":["string","null"],"format":"uuid"},"group2Key":{"type":"string"},"group2Name":{"type":"string"},"spendCents":{"type":"string"},"orderCount":{"type":"integer"},"itemCount":{"type":"integer"},"firstDate":{"type":["string","null"]},"lastDate":{"type":["string","null"]},"comparison":{"type":"object","properties":{"spendCents":{"type":"string"},"orderCount":{"type":"integer"},"itemCount":{"type":"integer"},"firstDate":{"type":["string","null"]},"lastDate":{"type":["string","null"]}},"required":["spendCents","orderCount","itemCount","firstDate","lastDate"],"additionalProperties":false},"deltas":{"type":"object","properties":{"spendCents":{"type":"string"},"orderCount":{"type":"integer"},"itemCount":{"type":"integer"}},"required":["spendCents","orderCount","itemCount"],"additionalProperties":false},"comparisonClassification":{"type":"string","enum":["new","lost","retained"]}},"required":["groupId","bucketKey","groupName","spendCents","orderCount","itemCount","firstDate","lastDate"],"additionalProperties":false}},"totals":{"type":"object","properties":{"scope":{"type":"string","enum":["filtered-population-before-pagination"]},"primary":{"type":"object","properties":{"spendCents":{"type":"string"},"itemCount":{"type":"integer"}},"required":["spendCents","itemCount"],"additionalProperties":false},"comparison":{"type":"object","properties":{"spendCents":{"type":"string"},"itemCount":{"type":"integer"}},"required":["spendCents","itemCount"],"additionalProperties":false},"deltas":{"type":"object","properties":{"spendCents":{"type":"string"},"itemCount":{"type":"integer"}},"required":["spendCents","itemCount"],"additionalProperties":false}},"required":["scope","primary"],"additionalProperties":false},"meta":{"type":"object","properties":{"totalGroups":{"type":"integer"},"returnedGroups":{"type":"integer"},"truncated":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"ordering":{"type":"string"},"hasMoreAfterPage":{"type":"boolean"},"rowsCoverFullPopulation":{"type":"boolean"},"rankingComplete":{"type":"boolean"},"sortBy":{"type":"string"},"sortDirection":{"type":"string","enum":["asc","desc"]}},"required":["totalGroups","returnedGroups","truncated","limit","offset","ordering","rowsCoverFullPopulation","rankingComplete"],"additionalProperties":false}},"required":["report","params","basis","rows","totals","meta"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"report":{"type":"object","properties":{"key":{"type":"string","enum":["open-sales-orders"]},"title":{"type":"string"},"description":{"type":"string"},"params":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"required":{"type":"boolean"},"description":{"type":"string"},"values":{"type":"array","items":{"type":"string"}},"defaultValue":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}}]}},"required":["name","required","description"],"additionalProperties":false}},"dimensions":{"type":"array","items":{"type":"string"}},"measures":{"type":"array","items":{"type":"string"}},"requiredScope":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]},"requiredScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"allowedForThisKey":{"type":"boolean"}},"required":["key","title","description","params","dimensions","measures","requiredScope","allowedForThisKey"],"additionalProperties":false},"params":{"type":"object","additionalProperties":{}},"basis":{"type":"object","properties":{"dateBasis":{"type":"string"},"timezone":{"type":"string"},"currencyMode":{"type":"string","enum":["org-base"]},"generatedAt":{"type":"string","format":"date-time"},"startDate":{"type":"string"},"endDate":{"type":"string"},"statusesRequested":{"type":"array","items":{"type":"string"}},"statusesEffective":{"type":"array","items":{"type":"string"}},"lineType":{"type":"string"},"rowsConsidered":{"type":"integer"},"fetchWindow":{"type":"object","properties":{"start":{"type":["string","null"]},"end":{"type":["string","null"]}},"required":["start","end"],"additionalProperties":false},"largeWindow":{"type":"boolean"},"primaryWindow":{"type":"object","properties":{"startDate":{"type":"string"},"endDate":{"type":"string"},"rowsConsidered":{"type":"integer"}},"required":["startDate","endDate","rowsConsidered"],"additionalProperties":false},"comparisonWindow":{"type":"object","properties":{"startDate":{"type":"string"},"endDate":{"type":"string"},"rowsConsidered":{"type":"integer"}},"required":["startDate","endDate","rowsConsidered"],"additionalProperties":false},"notes":{"type":"array","items":{"type":"string"}}},"required":["dateBasis","timezone","currencyMode","generatedAt","notes"],"additionalProperties":false},"rows":{"type":"array","items":{"type":"object","properties":{"groupId":{"type":["string","null"],"format":"uuid"},"bucketKey":{"type":"string"},"groupName":{"type":"string"},"group2Id":{"type":["string","null"],"format":"uuid"},"group2Key":{"type":"string"},"group2Name":{"type":"string"},"orderCount":{"type":"integer"},"itemCount":{"type":"integer"},"openValueCents":{"type":"string"}},"required":["groupId","bucketKey","groupName","orderCount","itemCount","openValueCents"],"additionalProperties":false}},"meta":{"type":"object","properties":{"totalGroups":{"type":"integer"},"returnedGroups":{"type":"integer"},"truncated":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"ordering":{"type":"string"},"hasMoreAfterPage":{"type":"boolean"},"rowsCoverFullPopulation":{"type":"boolean"},"rankingComplete":{"type":"boolean"},"sortBy":{"type":"string"},"sortDirection":{"type":"string","enum":["asc","desc"]}},"required":["totalGroups","returnedGroups","truncated","limit","offset","ordering"],"additionalProperties":false}},"required":["report","params","basis","rows","meta"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"report":{"type":"object","properties":{"key":{"type":"string","enum":["ar-aging"]},"title":{"type":"string"},"description":{"type":"string"},"params":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"required":{"type":"boolean"},"description":{"type":"string"},"values":{"type":"array","items":{"type":"string"}},"defaultValue":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}}]}},"required":["name","required","description"],"additionalProperties":false}},"dimensions":{"type":"array","items":{"type":"string"}},"measures":{"type":"array","items":{"type":"string"}},"requiredScope":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]},"requiredScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"allowedForThisKey":{"type":"boolean"}},"required":["key","title","description","params","dimensions","measures","requiredScope","allowedForThisKey"],"additionalProperties":false},"params":{"type":"object","additionalProperties":{}},"basis":{"type":"object","properties":{"dateBasis":{"type":"string","enum":["current-org-calendar-day"]},"timezone":{"type":"string"},"asOfDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"generatedAt":{"type":"string","format":"date-time"},"baseCurrencyCode":{"type":"string"},"accountingCutoverDay":{"type":["string","null"]},"coverageStartDate":{"type":["string","null"]},"historyState":{"type":"string","enum":["certified","preview","unverified_configuration_gap"]},"creditsIncluded":{"type":"boolean"},"currencyLaneNote":{"type":"string","enum":["transaction_currency_lanes"]},"paymentBehaviorBasis":{"type":["object","null"],"properties":{"observation":{"type":"string"},"learningWindow":{"type":"string"},"usualDaysLate":{"type":"string"},"recentDaysLate":{"type":"string"},"averageDaysToPay":{"type":"string"},"lastPaymentDate":{"type":"string"},"olderDueOpenCents":{"type":"string"},"olderDuePaidInWindowCents":{"type":"string"}},"required":["observation","learningWindow","usualDaysLate","recentDaysLate","averageDaysToPay","lastPaymentDate","olderDueOpenCents","olderDuePaidInWindowCents"],"additionalProperties":false},"notes":{"type":"array","items":{"type":"string"}},"currencyMode":{"type":"string","enum":["transaction-currency-subledger-ar"]}},"required":["dateBasis","timezone","asOfDate","generatedAt","baseCurrencyCode","accountingCutoverDay","coverageStartDate","historyState","creditsIncluded","currencyLaneNote","paymentBehaviorBasis","notes","currencyMode"],"additionalProperties":false},"rows":{"type":"array","items":{"type":"object","properties":{"transactionCurrencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"openDocumentCents":{"type":"string","pattern":"^-?\\d+$"},"openCreditCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"netCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"pastDueDocumentCents":{"type":"string","pattern":"^-?\\d+$"},"currentCents":{"type":"string","pattern":"^-?\\d+$"},"days1To30Cents":{"type":"string","pattern":"^-?\\d+$"},"days31To60Cents":{"type":"string","pattern":"^-?\\d+$"},"days61To90Cents":{"type":"string","pattern":"^-?\\d+$"},"days90PlusCents":{"type":"string","pattern":"^-?\\d+$"},"over365Cents":{"type":"string","pattern":"^-?\\d+$"},"unknownCents":{"type":"string","pattern":"^-?\\d+$"},"dueByCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"openingAmountCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"openingDocumentCount":{"type":"integer","minimum":0},"openDocumentCount":{"type":"integer","minimum":0},"pastDueDocumentCount":{"type":"integer","minimum":0},"unknownDueDocumentCount":{"type":"integer","minimum":0},"openCreditCount":{"type":["integer","null"],"minimum":0},"counterpartyId":{"type":"string","format":"uuid"},"counterpartyName":{"type":"string"},"counterpartyStatus":{"type":"string","enum":["active","prospect","archived"]},"oldestDueDate":{"type":["string","null"],"pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"oldestDaysPastDue":{"type":["integer","null"],"minimum":0},"paymentBehavior":{"type":["object","null"],"properties":{"lastPaymentDate":{"type":["string","null"]},"usualDaysLate":{"type":["number","null"],"description":"Median final cash day minus due day across eligible documents in the learning window."},"recentDaysLate":{"type":["number","null"],"description":"Median final cash day minus due day across eligible documents settled in the last 90 days within that window."},"averageDaysToPay":{"type":["number","null"],"description":"Arithmetic mean final cash day minus document day across eligible documents in the learning window."},"nativePaidDocumentCount":{"type":"integer"},"settledOtherwiseCount":{"type":"integer"},"olderDueOpenCents":{"type":"string"},"olderDuePaidInWindowCents":{"type":["string","null"]},"olderDueCreditInWindowCents":{"type":["string","null"]},"olderDueAdjustmentInWindowCents":{"type":["string","null"]},"cashUnavailableCount":{"type":"integer"},"crossCurrencyCashCount":{"type":"integer"},"coverageStartDate":{"type":["string","null"]},"cashUnavailableReason":{"type":["string","null"],"enum":["legacy_mixed_cash_and_credit","mixed_cash_and_credit_attribution_unrecorded","cross_currency_cash"]}},"required":["lastPaymentDate","usualDaysLate","recentDaysLate","averageDaysToPay","nativePaidDocumentCount","settledOtherwiseCount","olderDueOpenCents","olderDuePaidInWindowCents","olderDueCreditInWindowCents","olderDueAdjustmentInWindowCents","cashUnavailableCount","crossCurrencyCashCount","coverageStartDate","cashUnavailableReason"],"additionalProperties":false},"openInvoiceCents":{"type":"string","pattern":"^-?\\d+$"},"unappliedCreditCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"pastDueInvoiceCents":{"type":"string","pattern":"^-?\\d+$"},"openInvoiceCount":{"type":"integer","minimum":0},"pastDueInvoiceCount":{"type":"integer","minimum":0},"unknownDueInvoiceCount":{"type":"integer","minimum":0},"customerId":{"type":"string","format":"uuid"},"customerName":{"type":"string"}},"required":["transactionCurrencyCode","openDocumentCents","openCreditCents","netCents","pastDueDocumentCents","currentCents","days1To30Cents","days31To60Cents","days61To90Cents","days90PlusCents","over365Cents","unknownCents","dueByCents","openingAmountCents","openingDocumentCount","openDocumentCount","pastDueDocumentCount","unknownDueDocumentCount","openCreditCount","counterpartyId","counterpartyName","counterpartyStatus","oldestDueDate","oldestDaysPastDue","paymentBehavior","openInvoiceCents","unappliedCreditCents","pastDueInvoiceCents","openInvoiceCount","pastDueInvoiceCount","unknownDueInvoiceCount","customerId","customerName"],"additionalProperties":false}},"totals":{"type":"object","properties":{"scope":{"type":"string","enum":["filtered-population-before-pagination"]},"byTransactionCurrency":{"type":"array","items":{"type":"object","properties":{"transactionCurrencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"openDocumentCents":{"type":"string","pattern":"^-?\\d+$"},"openCreditCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"netCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"pastDueDocumentCents":{"type":"string","pattern":"^-?\\d+$"},"currentCents":{"type":"string","pattern":"^-?\\d+$"},"days1To30Cents":{"type":"string","pattern":"^-?\\d+$"},"days31To60Cents":{"type":"string","pattern":"^-?\\d+$"},"days61To90Cents":{"type":"string","pattern":"^-?\\d+$"},"days90PlusCents":{"type":"string","pattern":"^-?\\d+$"},"over365Cents":{"type":"string","pattern":"^-?\\d+$"},"unknownCents":{"type":"string","pattern":"^-?\\d+$"},"dueByCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"openingAmountCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"openingDocumentCount":{"type":"integer","minimum":0},"openDocumentCount":{"type":"integer","minimum":0},"pastDueDocumentCount":{"type":"integer","minimum":0},"unknownDueDocumentCount":{"type":"integer","minimum":0},"openCreditCount":{"type":["integer","null"],"minimum":0},"openInvoiceCents":{"type":"string","pattern":"^-?\\d+$"},"unappliedCreditCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"pastDueInvoiceCents":{"type":"string","pattern":"^-?\\d+$"},"openInvoiceCount":{"type":"integer","minimum":0},"pastDueInvoiceCount":{"type":"integer","minimum":0},"unknownDueInvoiceCount":{"type":"integer","minimum":0}},"required":["transactionCurrencyCode","openDocumentCents","openCreditCents","netCents","pastDueDocumentCents","currentCents","days1To30Cents","days31To60Cents","days61To90Cents","days90PlusCents","over365Cents","unknownCents","dueByCents","openingAmountCents","openingDocumentCount","openDocumentCount","pastDueDocumentCount","unknownDueDocumentCount","openCreditCount","openInvoiceCents","unappliedCreditCents","pastDueInvoiceCents","openInvoiceCount","pastDueInvoiceCount","unknownDueInvoiceCount"],"additionalProperties":false}},"baseCurrencyCode":{"type":"string"},"baseOpenDocumentCents":{"type":"string","pattern":"^-?\\d+$"},"baseOpenCreditCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"baseNetCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"openingBaseAmountCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"openingDocumentCount":{"type":"integer","minimum":0}},"required":["scope","byTransactionCurrency","baseCurrencyCode","baseOpenDocumentCents","baseOpenCreditCents","baseNetCents","openingBaseAmountCents","openingDocumentCount"],"additionalProperties":false},"drafts":{"type":"object","properties":{"count":{"type":"integer","minimum":0},"byTransactionCurrency":{"type":"array","items":{"type":"object","properties":{"transactionCurrencyCode":{"type":"string"},"count":{"type":"integer","minimum":0},"amountCents":{"type":"string","pattern":"^-?\\d+$"}},"required":["transactionCurrencyCode","count","amountCents"],"additionalProperties":false}}},"required":["count","byTransactionCurrency"],"additionalProperties":false},"paymentsBeingPrepared":{"type":["object","null"],"properties":{"scope":{"type":"string","enum":["organization","supplier"]},"batchCount":{"type":"integer","minimum":0},"oldestCreatedDate":{"type":["string","null"]},"byTransactionCurrency":{"type":"array","items":{"type":"object","properties":{"transactionCurrencyCode":{"type":"string"},"count":{"type":"integer","minimum":0},"amountCents":{"type":"string","pattern":"^-?\\d+$"}},"required":["transactionCurrencyCode","count","amountCents"],"additionalProperties":false}}},"required":["scope","batchCount","oldestCreatedDate","byTransactionCurrency"],"additionalProperties":false},"hygieneFacts":{"type":"array","items":{"type":"object","properties":{"counterpartyStatus":{"type":"string","enum":["archived","prospect"]},"transactionCurrencyCode":{"type":"string"},"counterpartyCount":{"type":"integer","minimum":0},"openDocumentCents":{"type":"string","pattern":"^-?\\d+$"}},"required":["counterpartyStatus","transactionCurrencyCode","counterpartyCount","openDocumentCents"],"additionalProperties":false}},"meta":{"type":"object","properties":{"totalGroups":{"type":"integer"},"returnedGroups":{"type":"integer"},"truncated":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"ordering":{"type":"string"},"hasMoreAfterPage":{"type":"boolean"},"rowsCoverFullPopulation":{"type":"boolean"},"rankingComplete":{"type":"boolean","enum":[true]},"sortBy":{"type":"string","enum":["netCents","pastDueInvoiceCents","days90PlusCents","oldestDaysPastDue"]},"sortDirection":{"type":"string","enum":["asc","desc"]},"populationDiagnostics":{"type":"object","properties":{"negativeDueCount":{"type":"integer","minimum":0},"paidWithDueCount":{"type":"integer","minimum":0},"postedZeroDueCount":{"type":"integer","minimum":0},"creditIncoherentCount":{"type":["integer","null"],"minimum":0},"zeroPaidPartialCount":{"type":"integer","minimum":0},"incoherentRecordCount":{"type":"integer","minimum":0}},"required":["negativeDueCount","paidWithDueCount","postedZeroDueCount","creditIncoherentCount","zeroPaidPartialCount","incoherentRecordCount"],"additionalProperties":false}},"required":["totalGroups","returnedGroups","truncated","limit","offset","ordering","rankingComplete","sortBy","sortDirection","populationDiagnostics"],"additionalProperties":false}},"required":["report","params","basis","rows","totals","drafts","paymentsBeingPrepared","hygieneFacts","meta"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"report":{"type":"object","properties":{"key":{"type":"string","enum":["pipeline-summary"]},"title":{"type":"string"},"description":{"type":"string"},"params":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"required":{"type":"boolean"},"description":{"type":"string"},"values":{"type":"array","items":{"type":"string"}},"defaultValue":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}}]}},"required":["name","required","description"],"additionalProperties":false}},"dimensions":{"type":"array","items":{"type":"string"}},"measures":{"type":"array","items":{"type":"string"}},"requiredScope":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]},"requiredScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"allowedForThisKey":{"type":"boolean"}},"required":["key","title","description","params","dimensions","measures","requiredScope","allowedForThisKey"],"additionalProperties":false},"params":{"type":"object","additionalProperties":{}},"basis":{"type":"object","properties":{"dateBasis":{"type":"string","enum":["opportunity-created-at"]},"timezone":{"type":"string"},"currencyMode":{"type":"string","enum":["single-org-base-estimate"]},"currencyCode":{"type":["string","null"],"pattern":"^[A-Z]{3}$"},"generatedAt":{"type":"string","format":"date-time"},"notes":{"type":"array","items":{"type":"string"}}},"required":["dateBasis","timezone","currencyMode","currencyCode","generatedAt","notes"],"additionalProperties":false},"rows":{"type":"array","items":{"type":"object","properties":{"groupId":{"type":["string","null"],"format":"uuid"},"bucketKey":{"type":"string"},"groupName":{"type":"string"},"opportunityCount":{"type":"integer","minimum":0},"estimatedValueTotal":{"type":"string","pattern":"^\\d+(?:\\.\\d{2})$"},"currencyCode":{"type":["string","null"],"pattern":"^[A-Z]{3}$"},"noValueCount":{"type":"integer","minimum":0},"wonCount":{"type":"integer","minimum":0},"lostCount":{"type":"integer","minimum":0},"oldestOpenCreatedAt":{"type":["string","null"],"format":"date-time"}},"required":["groupId","bucketKey","groupName","opportunityCount","estimatedValueTotal","currencyCode","noValueCount","wonCount","lostCount","oldestOpenCreatedAt"],"additionalProperties":false}},"totals":{"type":"object","properties":{"scope":{"type":"string","enum":["filtered-opportunity-population-before-pagination"]},"opportunityCount":{"type":"integer","minimum":0},"estimatedValueTotal":{"type":"string","pattern":"^\\d+(?:\\.\\d{2})$"},"currencyCode":{"type":["string","null"],"pattern":"^[A-Z]{3}$"},"noValueCount":{"type":"integer","minimum":0},"wonCount":{"type":"integer","minimum":0},"lostCount":{"type":"integer","minimum":0}},"required":["scope","opportunityCount","estimatedValueTotal","currencyCode","noValueCount","wonCount","lostCount"],"additionalProperties":false},"meta":{"type":"object","properties":{"totalGroups":{"type":"integer"},"returnedGroups":{"type":"integer"},"truncated":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"ordering":{"type":"string"},"hasMoreAfterPage":{"type":"boolean"},"rowsCoverFullPopulation":{"type":"boolean"},"rankingComplete":{"type":"boolean"},"sortBy":{"type":"string"},"sortDirection":{"type":"string","enum":["asc","desc"]}},"required":["totalGroups","returnedGroups","truncated","limit","offset","ordering"],"additionalProperties":false}},"required":["report","params","basis","rows","totals","meta"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"params":{"type":"object","properties":{"customerId":{"type":["string","null"],"format":"uuid","default":null},"from":{"type":["string","null"],"pattern":"^\\d{4}-\\d{2}-\\d{2}$","default":null},"to":{"type":["string","null"],"pattern":"^\\d{4}-\\d{2}-\\d{2}$","default":null},"includeOpeningDocuments":{"type":"boolean","default":false},"limit":{"type":"integer","minimum":1,"maximum":100,"default":25}},"additionalProperties":false},"basis":{"type":"object","properties":{"organization":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","minLength":1,"maxLength":500},"timezone":{"type":"string","minLength":1,"maxLength":500},"baseCurrencyCode":{"type":"string","pattern":"^[A-Z]{3}$"}},"required":["id","name","timezone","baseCurrencyCode"],"additionalProperties":false},"customerScope":{"type":"object","properties":{"kind":{"type":"string","enum":["all","customer"]},"customerId":{"type":["string","null"],"format":"uuid"},"customerName":{"type":["string","null"],"minLength":1,"maxLength":500}},"required":["kind","customerId","customerName"],"additionalProperties":false},"requestedWindow":{"type":"object","properties":{"from":{"type":["string","null"],"pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"to":{"type":["string","null"],"pattern":"^\\d{4}-\\d{2}-\\d{2}$"}},"required":["from","to"],"additionalProperties":false},"effectiveWindow":{"type":"object","properties":{"from":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"to":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"}},"required":["from","to"],"additionalProperties":false},"currencyBasis":{"type":"object","properties":{"kind":{"type":"string","enum":["organization_base_currency"]},"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"}},"required":["kind","currencyCode"],"additionalProperties":false},"population":{"type":"string","minLength":1,"maxLength":500},"exclusions":{"type":"array","items":{"type":"string","minLength":1,"maxLength":500}},"historyState":{"type":"string","enum":["certified","preview","unverified_configuration_gap"]},"accountingCutoverDay":{"type":["string","null"],"pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"paymentBehaviorBasis":{"type":["object","null"],"properties":{"observation":{"type":"string"},"learningWindow":{"type":"string"},"usualDaysLate":{"type":"string"},"recentDaysLate":{"type":"string"},"averageDaysToPay":{"type":"string"},"lastPaymentDate":{"type":"string"},"olderDueOpenCents":{"type":"string"},"olderDuePaidInWindowCents":{"type":"string"}},"required":["observation","learningWindow","usualDaysLate","recentDaysLate","averageDaysToPay","lastPaymentDate","olderDueOpenCents","olderDuePaidInWindowCents"],"additionalProperties":false}},"required":["organization","customerScope","requestedWindow","effectiveWindow","currencyBasis","population","exclusions","historyState","accountingCutoverDay","paymentBehaviorBasis"],"additionalProperties":false},"rows":{"type":"array","items":{"type":"object","properties":{"invoiceId":{"type":"string","format":"uuid"},"invoiceNumber":{"type":"string","minLength":1,"maxLength":500},"customerId":{"type":"string","format":"uuid"},"customerName":{"type":"string","minLength":1,"maxLength":500},"counterpartyStatus":{"type":"string","enum":["active","prospect","archived"]},"cohort":{"type":"string","enum":["native","opening_ar","preview"]},"invoiceDay":{"type":["string","null"],"pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"dueDay":{"type":["string","null"],"pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"finalSettlementDay":{"type":["string","null"],"pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"dateProvenance":{"type":"string","enum":["materialized_paid_date","derived_from_posted_allocations","materialized_and_derived_agree","materialized_and_derived_diverge","unavailable"]},"daysToFinalSettlement":{"type":["integer","null"]},"daysVersusDue":{"type":["integer","null"]},"transactionCurrencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"transactionAmountCents":{"type":"string","pattern":"^-?\\d+$"},"baseAmountCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"writeOffBaseAmountCents":{"type":["string","null"],"pattern":"^-?\\d+$"}},"required":["invoiceId","invoiceNumber","customerId","customerName","counterpartyStatus","cohort","invoiceDay","dueDay","finalSettlementDay","dateProvenance","daysToFinalSettlement","daysVersusDue","transactionCurrencyCode","transactionAmountCents","baseAmountCents","writeOffBaseAmountCents"],"additionalProperties":false}},"customerRows":{"type":"array","items":{"type":"object","properties":{"lastPaymentDate":{"type":["string","null"]},"usualDaysLate":{"type":["number","null"],"description":"Median final cash day minus due day across eligible documents in the learning window."},"recentDaysLate":{"type":["number","null"],"description":"Median final cash day minus due day across eligible documents settled in the last 90 days within that window."},"averageDaysToPay":{"type":["number","null"],"description":"Arithmetic mean final cash day minus document day across eligible documents in the learning window."},"nativePaidDocumentCount":{"type":"integer"},"settledOtherwiseCount":{"type":"integer"},"olderDueOpenCents":{"type":"string"},"olderDuePaidInWindowCents":{"type":["string","null"]},"olderDueCreditInWindowCents":{"type":["string","null"]},"olderDueAdjustmentInWindowCents":{"type":["string","null"]},"cashUnavailableCount":{"type":"integer"},"crossCurrencyCashCount":{"type":"integer"},"coverageStartDate":{"type":["string","null"]},"cashUnavailableReason":{"type":["string","null"],"enum":["legacy_mixed_cash_and_credit","mixed_cash_and_credit_attribution_unrecorded","cross_currency_cash"]},"customerId":{"type":"string","format":"uuid"},"customerName":{"type":"string","minLength":1,"maxLength":500},"counterpartyStatus":{"type":"string","enum":["active","prospect","archived"]},"transactionCurrencyCode":{"type":"string","pattern":"^[A-Z]{3}$"}},"required":["lastPaymentDate","usualDaysLate","recentDaysLate","averageDaysToPay","nativePaidDocumentCount","settledOtherwiseCount","olderDueOpenCents","olderDuePaidInWindowCents","olderDueCreditInWindowCents","olderDueAdjustmentInWindowCents","cashUnavailableCount","crossCurrencyCashCount","coverageStartDate","cashUnavailableReason","customerId","customerName","counterpartyStatus","transactionCurrencyCode"],"additionalProperties":false}},"totals":{"type":"object","properties":{"settledInvoiceCount":{"type":"integer","minimum":0},"settledBaseAmountCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"weightedAverageDaysToFinalSettlement":{"type":["number","null"]},"weightedAverageDaysVersusDue":{"type":["number","null"]},"medianDaysVersusDue":{"type":["number","null"]},"onTimeByCount":{"type":"object","properties":{"numerator":{"type":"integer","minimum":0},"denominator":{"type":"integer","minimum":0}},"required":["numerator","denominator"],"additionalProperties":false},"onTimeByBaseAmount":{"type":"object","properties":{"numeratorCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"denominatorCents":{"type":["string","null"],"pattern":"^-?\\d+$"}},"required":["numeratorCents","denominatorCents"],"additionalProperties":false}},"required":["settledInvoiceCount","settledBaseAmountCents","weightedAverageDaysToFinalSettlement","weightedAverageDaysVersusDue","medianDaysVersusDue","onTimeByCount","onTimeByBaseAmount"],"additionalProperties":false},"meta":{"type":"object","properties":{"sourcePopulationCount":{"type":"integer","minimum":0},"resultPopulationCount":{"type":"integer","minimum":0},"totalGroups":{"type":"integer","minimum":0},"returnedGroups":{"type":"integer","minimum":0},"truncated":{"type":"boolean"},"limit":{"type":"integer","exclusiveMinimum":0},"offset":{"type":"number","enum":[0]},"ordering":{"type":"string","minLength":1,"maxLength":500},"observedAt":{"type":"string","format":"date-time"},"evidenceComplete":{"type":"boolean"},"coverage":{"type":"object","properties":{"materializedDates":{"type":"integer","minimum":0},"derivedDates":{"type":"integer","minimum":0},"agreeingDates":{"type":"integer","minimum":0},"divergentDates":{"type":"integer","minimum":0},"missingSettlementDates":{"type":"integer","minimum":0},"missingInvoiceDates":{"type":"integer","minimum":0},"missingDueDates":{"type":"integer","minimum":0},"missingBaseAmounts":{"type":"integer","minimum":0},"missingWriteOffBaseAmounts":{"type":"integer","minimum":0}},"required":["materializedDates","derivedDates","agreeingDates","divergentDates","missingSettlementDates","missingInvoiceDates","missingDueDates","missingBaseAmounts","missingWriteOffBaseAmounts"],"additionalProperties":false}},"required":["sourcePopulationCount","resultPopulationCount","totalGroups","returnedGroups","truncated","limit","offset","ordering","observedAt","evidenceComplete","coverage"],"additionalProperties":false},"report":{"type":"object","properties":{"key":{"type":"string","enum":["customer-invoice-settlement-behavior"]},"title":{"type":"string"},"description":{"type":"string"},"params":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"required":{"type":"boolean"},"description":{"type":"string"},"values":{"type":"array","items":{"type":"string"}},"defaultValue":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}}]}},"required":["name","required","description"],"additionalProperties":false}},"dimensions":{"type":"array","items":{"type":"string"}},"measures":{"type":"array","items":{"type":"string"}},"requiredScope":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]},"requiredScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"allowedForThisKey":{"type":"boolean"}},"required":["key","title","description","params","dimensions","measures","requiredScope","allowedForThisKey"],"additionalProperties":false}},"required":["params","basis","rows","customerRows","totals","meta","report"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"params":{"type":"object","properties":{"customerId":{"type":["string","null"],"format":"uuid","default":null},"sortBy":{"type":"string","enum":["totalExposure","overage","utilization","postedExposure","committedExposure","customerName"],"default":"totalExposure"},"sortDirection":{"type":"string","enum":["asc","desc"],"default":"desc"},"flags":{"type":"array","items":{"type":"string","enum":["within_posted_over_with_commitments","over_limit","shipped_or_delivered_unbilled","no_limit","credit_limit_configuration_issue","incomplete_financial_evidence"]},"maxItems":6,"default":[]},"limit":{"type":"integer","minimum":1,"maximum":500,"default":100}},"additionalProperties":false},"basis":{"type":"object","properties":{"organization":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","minLength":1,"maxLength":500},"timezone":{"type":"string","minLength":1,"maxLength":500},"baseCurrencyCode":{"type":"string","pattern":"^[A-Z]{3}$"}},"required":["id","name","timezone","baseCurrencyCode"],"additionalProperties":false},"customerScope":{"type":"object","properties":{"kind":{"type":"string","enum":["all","customer"]},"customerId":{"type":["string","null"],"format":"uuid"},"customerName":{"type":["string","null"],"minLength":1,"maxLength":500}},"required":["kind","customerId","customerName"],"additionalProperties":false},"asOf":{"type":"string","format":"date-time"},"currencyBasis":{"type":"object","properties":{"kind":{"type":"string","enum":["organization_base_currency"]},"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"}},"required":["kind","currencyCode"],"additionalProperties":false},"population":{"type":"string","minLength":1,"maxLength":500},"exclusions":{"type":"array","items":{"type":"string","minLength":1,"maxLength":500}}},"required":["organization","customerScope","asOf","currencyBasis","population","exclusions"],"additionalProperties":false},"rows":{"type":"array","items":{"type":"object","properties":{"customerId":{"type":"string","format":"uuid"},"customerName":{"type":"string","minLength":1,"maxLength":500},"counterpartyStatus":{"type":"string","enum":["active","prospect","archived"]},"grossOpenInvoiceBaseCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"openCreditBaseCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"netPostedExposureBaseCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"committedUninvoicedBaseCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"committedByOrderState":{"type":"object","properties":{"confirmedBaseCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"shippedBaseCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"deliveredBaseCents":{"type":["string","null"],"pattern":"^-?\\d+$"}},"required":["confirmedBaseCents","shippedBaseCents","deliveredBaseCents"],"additionalProperties":false},"totalExposureBaseCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"creditLimit":{"type":"object","properties":{"state":{"type":"string","enum":["available","missing","ambiguous","conflicting_legacy_values"]},"baseCents":{"type":["string","null"],"pattern":"^-?\\d+$"}},"required":["state","baseCents"],"additionalProperties":false},"availableCreditBaseCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"utilizationPercent":{"type":["number","null"]},"overageBaseCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"flags":{"type":"array","items":{"type":"string","enum":["within_posted_over_with_commitments","over_limit","shipped_or_delivered_unbilled","no_limit","credit_limit_configuration_issue","incomplete_financial_evidence"]}},"coverage":{"type":"object","properties":{"missingInvoiceBaseRows":{"type":"integer","minimum":0},"missingCreditBaseRows":{"type":"integer","minimum":0},"missingOrderBaseRows":{"type":"integer","minimum":0},"unmatchedInvoiceAttributionRows":{"type":"integer","minimum":0}},"required":["missingInvoiceBaseRows","missingCreditBaseRows","missingOrderBaseRows","unmatchedInvoiceAttributionRows"],"additionalProperties":false}},"required":["customerId","customerName","counterpartyStatus","grossOpenInvoiceBaseCents","openCreditBaseCents","netPostedExposureBaseCents","committedUninvoicedBaseCents","committedByOrderState","totalExposureBaseCents","creditLimit","availableCreditBaseCents","utilizationPercent","overageBaseCents","flags","coverage"],"additionalProperties":false}},"totals":{"type":"object","properties":{"grossOpenInvoiceBaseCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"openCreditBaseCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"netPostedExposureBaseCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"committedUninvoicedBaseCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"totalExposureBaseCents":{"type":["string","null"],"pattern":"^-?\\d+$"}},"required":["grossOpenInvoiceBaseCents","openCreditBaseCents","netPostedExposureBaseCents","committedUninvoicedBaseCents","totalExposureBaseCents"],"additionalProperties":false},"flagSummaries":{"type":"array","items":{"type":"object","properties":{"flag":{"type":"string","enum":["within_posted_over_with_commitments","over_limit","shipped_or_delivered_unbilled","no_limit","credit_limit_configuration_issue","incomplete_financial_evidence"]},"customerCount":{"type":"integer","minimum":0},"totalExposureBaseCents":{"type":["string","null"],"pattern":"^-?\\d+$"}},"required":["flag","customerCount","totalExposureBaseCents"],"additionalProperties":false}},"meta":{"type":"object","properties":{"sourcePopulationCount":{"type":"integer","minimum":0},"resultPopulationCount":{"type":"integer","minimum":0},"totalGroups":{"type":"integer","minimum":0},"returnedGroups":{"type":"integer","minimum":0},"truncated":{"type":"boolean"},"limit":{"type":"integer","exclusiveMinimum":0},"offset":{"type":"number","enum":[0]},"ordering":{"type":"string","minLength":1,"maxLength":500},"observedAt":{"type":"string","format":"date-time"},"evidenceComplete":{"type":"boolean"}},"required":["sourcePopulationCount","resultPopulationCount","totalGroups","returnedGroups","truncated","limit","offset","ordering","observedAt","evidenceComplete"],"additionalProperties":false},"report":{"type":"object","properties":{"key":{"type":"string","enum":["customer-credit-exposure"]},"title":{"type":"string"},"description":{"type":"string"},"params":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"required":{"type":"boolean"},"description":{"type":"string"},"values":{"type":"array","items":{"type":"string"}},"defaultValue":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}}]}},"required":["name","required","description"],"additionalProperties":false}},"dimensions":{"type":"array","items":{"type":"string"}},"measures":{"type":"array","items":{"type":"string"}},"requiredScope":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]},"requiredScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"allowedForThisKey":{"type":"boolean"}},"required":["key","title","description","params","dimensions","measures","requiredScope","allowedForThisKey"],"additionalProperties":false}},"required":["params","basis","rows","totals","flagSummaries","meta","report"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"params":{"type":"object","properties":{"customerId":{"type":["string","null"],"format":"uuid","default":null},"from":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"to":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"costCategoryId":{"type":["string","null"],"format":"uuid","default":null},"query":{"type":["string","null"],"minLength":1,"maxLength":120,"default":null},"limit":{"type":"integer","minimum":1,"maximum":100,"default":25}},"required":["from","to"],"additionalProperties":false},"basis":{"type":"object","properties":{"organization":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","minLength":1,"maxLength":500},"timezone":{"type":"string","minLength":1,"maxLength":500},"baseCurrencyCode":{"type":"string","pattern":"^[A-Z]{3}$"}},"required":["id","name","timezone","baseCurrencyCode"],"additionalProperties":false},"customerScope":{"type":"object","properties":{"kind":{"type":"string","enum":["all","customer"]},"customerId":{"type":["string","null"],"format":"uuid"},"customerName":{"type":["string","null"],"minLength":1,"maxLength":500}},"required":["kind","customerId","customerName"],"additionalProperties":false},"window":{"type":"object","properties":{"from":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"to":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"}},"required":["from","to"],"additionalProperties":false},"dateBasis":{"type":"string","enum":["invoice_or_credit_posted_day"]},"currencyBasis":{"type":"object","properties":{"kind":{"type":"string","enum":["organization_base_currency"]},"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"}},"required":["kind","currencyCode"],"additionalProperties":false},"population":{"type":"string","minLength":1,"maxLength":500},"exclusions":{"type":"array","items":{"type":"string","minLength":1,"maxLength":500}}},"required":["organization","customerScope","window","dateBasis","currencyBasis","population","exclusions"],"additionalProperties":false},"rows":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["invoice_charge","matched_credit"]},"recordId":{"type":"string","format":"uuid"},"customerId":{"type":"string","format":"uuid"},"customerName":{"type":"string","minLength":1,"maxLength":500},"counterpartyStatus":{"type":"string","enum":["active","prospect","archived"]},"postedDay":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"documentNumber":{"type":"string","minLength":1,"maxLength":500},"description":{"type":"string","minLength":1,"maxLength":500},"ledgerAccountId":{"type":["string","null"],"format":"uuid"},"ledgerAccountName":{"type":["string","null"],"minLength":1,"maxLength":500},"ledgerAccountPath":{"type":["string","null"],"minLength":1,"maxLength":500},"costCategoryId":{"type":["string","null"],"format":"uuid"},"matchReason":{"type":"string","enum":["configured_category","literal_description","literal_account","configured_and_literal"]},"transactionCurrencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"transactionAmountCents":{"type":"string","pattern":"^-?\\d+$"},"baseAmountCents":{"type":["string","null"],"pattern":"^-?\\d+$"}},"required":["kind","recordId","customerId","customerName","counterpartyStatus","postedDay","documentNumber","description","ledgerAccountId","ledgerAccountName","ledgerAccountPath","costCategoryId","matchReason","transactionCurrencyCode","transactionAmountCents","baseAmountCents"],"additionalProperties":false}},"totals":{"type":"object","properties":{"grossChargeBaseCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"matchedCreditBaseCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"netChargeBaseCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"configuredMatchCount":{"type":"integer","minimum":0},"literalMatchCount":{"type":"integer","minimum":0},"bothMatchCount":{"type":"integer","minimum":0}},"required":["grossChargeBaseCents","matchedCreditBaseCents","netChargeBaseCents","configuredMatchCount","literalMatchCount","bothMatchCount"],"additionalProperties":false},"meta":{"type":"object","properties":{"sourcePopulationCount":{"type":"integer","minimum":0},"resultPopulationCount":{"type":"integer","minimum":0},"totalGroups":{"type":"integer","minimum":0},"returnedGroups":{"type":"integer","minimum":0},"truncated":{"type":"boolean"},"limit":{"type":"integer","exclusiveMinimum":0},"offset":{"type":"number","enum":[0]},"ordering":{"type":"string","minLength":1,"maxLength":500},"observedAt":{"type":"string","format":"date-time"},"evidenceComplete":{"type":"boolean"},"coverage":{"type":"object","properties":{"matchingRows":{"type":"integer","minimum":0},"missingBaseRows":{"type":"integer","minimum":0},"uncategorizedRows":{"type":"integer","minimum":0}},"required":["matchingRows","missingBaseRows","uncategorizedRows"],"additionalProperties":false}},"required":["sourcePopulationCount","resultPopulationCount","totalGroups","returnedGroups","truncated","limit","offset","ordering","observedAt","evidenceComplete","coverage"],"additionalProperties":false},"report":{"type":"object","properties":{"key":{"type":"string","enum":["customer-invoice-charges"]},"title":{"type":"string"},"description":{"type":"string"},"params":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"required":{"type":"boolean"},"description":{"type":"string"},"values":{"type":"array","items":{"type":"string"}},"defaultValue":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}}]}},"required":["name","required","description"],"additionalProperties":false}},"dimensions":{"type":"array","items":{"type":"string"}},"measures":{"type":"array","items":{"type":"string"}},"requiredScope":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]},"requiredScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"allowedForThisKey":{"type":"boolean"}},"required":["key","title","description","params","dimensions","measures","requiredScope","allowedForThisKey"],"additionalProperties":false}},"required":["params","basis","rows","totals","meta","report"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}]},"PublicAPICostBookListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["user"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["system"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string","enum":["System User"]}},"required":["type","id","displayName"],"additionalProperties":false}]},"resourceType":{"type":"string","enum":["cost_book_entry"]},"entryType":{"type":"string","enum":["direct","constructed"]},"product":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"code":{"type":"string"},"displayName":{"type":"string"},"archived":{"type":"boolean"},"url":{"type":"string","format":"uri"}},"required":["id","code","displayName","archived","url"],"additionalProperties":false},"supplier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"externalId":{"type":["string","null"]},"archived":{"type":"boolean"},"url":{"type":"string","format":"uri"}},"required":["id","displayName","externalId","archived","url"],"additionalProperties":false},"arrangement":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"kind":{"type":"string","enum":["GENERAL","AT_PICKUP","AT_DESTINATION"]},"isTaught":{"type":"boolean"}},"required":["id","name","kind","isTaught"],"additionalProperties":false},"shipFromLocation":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false},"incoterm":{"type":["string","null"],"enum":["EXW","FCA","FAS","FOB","CFR","CIF","CPT","CIP","DAP","DPU","DDP","None"]},"supplierTerms":{"type":["string","null"]},"rates":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"integer","minimum":0},"amount":{"type":"object","properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string"},"uom":{"type":"string","enum":["GALLON","LITER","POUND","KILOGRAM","EACH","METRIC_TON","SHORT_TON"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom"],"additionalProperties":false},"minimumQuantity":{"type":["string","null"]},"minimumBasis":{"type":["string","null"],"enum":["product_uom","package"]},"minimumPackage":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"quantity":{"type":"string"},"uom":{"type":"string"}},"required":["id","name","quantity","uom"],"additionalProperties":false}},"required":["sequence","amount","minimumQuantity","minimumBasis","minimumPackage"],"additionalProperties":false}},"lineage":{"type":["object","null"],"properties":{"authoredByMode":{"type":["string","null"],"enum":["updateCost","editCost"]},"authoredAt":{"type":["string","null"],"format":"date-time"},"authoredById":{"type":["string","null"],"format":"uuid"},"supersedesEntryId":{"type":["string","null"],"format":"uuid"},"correctsEntryId":{"type":["string","null"],"format":"uuid"},"supersededAt":{"type":["string","null"],"format":"date-time"}},"required":["authoredByMode","authoredAt","authoredById","supersedesEntryId","correctsEntryId","supersededAt"],"additionalProperties":false},"resolutionState":{"type":"string","enum":["resolved","quantity_required","unavailable"]},"effectiveState":{"type":"string","enum":["active","scheduled","expired"]},"versionState":{"type":"string","enum":["current","superseded"]},"claimRole":{"type":"string","enum":["authoritative","supporting","non_authoritative"]},"disposition":{"type":"string","enum":["eligible","dismissed","archived"]},"effectiveFrom":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"effectiveTo":{"type":["string","null"],"pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"construction":{"type":"object","properties":{"type":{"type":"string","enum":["direct","constructed"]},"startingCost":{"anyOf":[{"type":"object","properties":{"source":{"type":"string","enum":["entered"]},"entryId":{"type":["string","null"],"format":"uuid"},"basis":{"type":["string","null"],"enum":["material","landed"]},"amount":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string"},"uom":{"type":"string","enum":["GALLON","LITER","POUND","KILOGRAM","EACH","METRIC_TON","SHORT_TON"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom"],"additionalProperties":false},"provenance":{"type":["object","null"],"properties":{"origin":{"type":"string","enum":["manual","integration","agent","import"]},"sourceRef":{"type":["string","null"]},"verifiedAt":{"type":["string","null"],"format":"date-time"},"verifiedBy":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["id","displayName"],"additionalProperties":false}},"required":["origin","sourceRef","verifiedAt","verifiedBy"],"additionalProperties":false}},"required":["source","entryId","basis","amount","provenance"],"additionalProperties":false},{"type":"object","properties":{"source":{"type":"string","enum":["cost_book_entry"]},"entryId":{"type":["string","null"],"format":"uuid"},"product":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"code":{"type":"string"},"displayName":{"type":"string"},"archived":{"type":"boolean"},"url":{"type":"string","format":"uri"}},"required":["id","code","displayName","archived","url"],"additionalProperties":false},"basis":{"type":["string","null"],"enum":["material","landed"]},"amount":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string"},"uom":{"type":"string","enum":["GALLON","LITER","POUND","KILOGRAM","EACH","METRIC_TON","SHORT_TON"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom"],"additionalProperties":false},"provenance":{"type":["object","null"],"properties":{"origin":{"type":"string","enum":["manual","integration","agent","import"]},"sourceRef":{"type":["string","null"]},"verifiedAt":{"type":["string","null"],"format":"date-time"},"verifiedBy":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["id","displayName"],"additionalProperties":false}},"required":["origin","sourceRef","verifiedAt","verifiedBy"],"additionalProperties":false}},"required":["source","entryId","product","basis","amount","provenance"],"additionalProperties":false}]},"additionalCosts":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"integer","minimum":0},"class":{"type":"string","enum":["FREIGHT","PACKAGING","DUTY","STORAGE","PROCESSING","HANDLING","TAX","OTHER"]},"method":{"type":"string","enum":["percent_of_starting_cost","cents_per_base_uom","cents_per_package"]},"value":{"type":"string"},"description":{"type":["string","null"]},"resolvedContribution":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string"},"uom":{"type":"string","enum":["GALLON","LITER","POUND","KILOGRAM","EACH","METRIC_TON","SHORT_TON"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom"],"additionalProperties":false}},"required":["sequence","class","method","value","description","resolvedContribution"],"additionalProperties":false}}},"required":["type","startingCost","additionalCosts"],"additionalProperties":false},"additionalCostTotal":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string"},"uom":{"type":"string","enum":["GALLON","LITER","POUND","KILOGRAM","EACH","METRIC_TON","SHORT_TON"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom"],"additionalProperties":false},"totalCost":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string"},"uom":{"type":"string","enum":["GALLON","LITER","POUND","KILOGRAM","EACH","METRIC_TON","SHORT_TON"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom"],"additionalProperties":false},"provenance":{"type":"object","properties":{"origin":{"type":"string","enum":["manual","integration","agent","import"]},"sourceRef":{"type":["string","null"]},"verifiedAt":{"type":["string","null"],"format":"date-time"},"verifiedBy":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["id","displayName"],"additionalProperties":false}},"required":["origin","sourceRef","verifiedAt","verifiedBy"],"additionalProperties":false},"completeness":{"type":"object","properties":{"status":{"type":"string","enum":["complete","unresolved"]},"warningCodes":{"type":"array","items":{"type":"string"}}},"required":["status","warningCodes"],"additionalProperties":false},"waitingReason":{"type":"string","description":"Present when a constructed entry has no total because its starting price is not current."},"costBookUrl":{"type":"string","format":"uri"}},"required":["id","createdAt","resourceType","entryType","product","supplier","shipFromLocation","incoterm","supplierTerms","rates","resolutionState","effectiveState","versionState","claimRole","disposition","effectiveFrom","effectiveTo","construction","additionalCostTotal","totalCost","provenance","completeness","costBookUrl"],"additionalProperties":false}},"meta":{"type":"object","properties":{"view":{"type":"string","enum":["current","history"]},"asOf":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"limit":{"type":"integer"},"hasMore":{"type":"boolean"},"nextCursor":{"type":["string","null"]},"matchStatus":{"type":"string","enum":["matched","missing","unresolved"]},"completeness":{"type":"object","properties":{"completeCount":{"type":"integer"},"unresolvedCount":{"type":"integer"}},"required":["completeCount","unresolvedCount"],"additionalProperties":false},"warnings":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"generatedAt":{"type":"string","format":"date-time"}},"required":["view","asOf","limit","hasMore","nextCursor","completeness","warnings","generatedAt"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false},"PublicAPICostBookPrediction":{"type":"object","properties":{"entryType":{"type":"string","enum":["direct","constructed"]},"construction":{"type":"object","properties":{"type":{"type":"string","enum":["direct","constructed"]},"startingCost":{"type":"object","properties":{"source":{"type":"string","enum":["entered","cost_book_entry"]},"entryId":{"type":["string","null"],"format":"uuid"},"productId":{"type":["string","null"],"format":"uuid"},"basis":{"type":["string","null"],"enum":["material","landed"]},"amount":{"type":"object","properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string"},"uom":{"type":"string","enum":["GALLON","LITER","POUND","KILOGRAM","EACH","METRIC_TON","SHORT_TON"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom"],"additionalProperties":false}},"required":["source","entryId","productId","basis","amount"],"additionalProperties":false},"additionalCosts":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"integer","minimum":0},"class":{"type":"string","enum":["FREIGHT","PACKAGING","DUTY","STORAGE","PROCESSING","HANDLING","TAX","OTHER"]},"method":{"type":"string","enum":["percent_of_starting_cost","cents_per_base_uom","cents_per_package"]},"value":{"type":"string"},"description":{"type":["string","null"]},"resolvedContribution":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string"},"uom":{"type":"string","enum":["GALLON","LITER","POUND","KILOGRAM","EACH","METRIC_TON","SHORT_TON"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom"],"additionalProperties":false}},"required":["sequence","class","method","value","description","resolvedContribution"],"additionalProperties":false}}},"required":["type","startingCost","additionalCosts"],"additionalProperties":false},"additionalCostTotal":{"type":"object","properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string"},"uom":{"type":"string","enum":["GALLON","LITER","POUND","KILOGRAM","EACH","METRIC_TON","SHORT_TON"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom"],"additionalProperties":false},"totalCost":{"type":"object","properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string"},"uom":{"type":"string","enum":["GALLON","LITER","POUND","KILOGRAM","EACH","METRIC_TON","SHORT_TON"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom"],"additionalProperties":false},"completeness":{"type":"object","properties":{"status":{"type":"string","enum":["complete"]},"warningCodes":{"type":"array","items":{"type":"string"}}},"required":["status","warningCodes"],"additionalProperties":false}},"required":["entryType","construction","additionalCostTotal","totalCost","completeness"],"additionalProperties":false},"PublicAPICostBookWriteReadinessResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["write_readiness"]},"operation":{"type":"string","enum":["cost_book_entries.create"]},"status":{"type":"string","enum":["ready","blocked"]},"wouldWrite":{"type":"boolean","enum":[false]},"submit":{"type":"object","properties":{"method":{"type":"string","enum":["POST","PATCH","PUT","DELETE"]},"path":{"type":"string"},"query":{"type":"object","properties":{},"additionalProperties":false}},"required":["method","path","query"],"additionalProperties":false},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false},"checks":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["not_direct_ship","address_role_required","address_role_valid","already_assigned","already_exists","active_duplicate","ambiguous_external_id","ambiguous_natural_key","api_created","archived_target","archived_record","archive_blocked","account_type_locked","duplicate_candidate_found","duplicate_candidate_overflow","duplicate_check_clear","duplicate_check_not_needed","duplicate_contact","duplicate_customer","duplicate_customer_address","duplicate_customer_location","duplicate_note","duplicate_resolution_applied","duplicate_supplier","duplicate_supplier_ship_from_location","document_url_org_scoped","document_url_valid","upload_verified","sds_converged","idempotency_available","idempotency_key_required","idempotency_key_reused","idempotency_replay","idempotency_target_missing","income_statement_type_invalid","hard_identity_clear","nested_external_id_clear","commercial_references_valid","credit_denomination_mismatch","customer_service_representative_reference_active","ledger_account_reference_valid","payment_terms_reference_exists","sales_person_reference_active","supplier_representative_reference_active","duplicate_reference_identity","external_id_conflict","if_match_current","base_uom_transition_allowed","base_uom_transition_blocked","attribute_assignments_valid","attribute_assignments_invalid","selected_supplier_link","linked_records_available","natural_key_conflict","not_api_created","no_downstream_mutation","order_sensitive_update_allowed","order_sensitive_update_blocked","parent_available","cost_book_entry_blocked","cost_book_entry_valid","cost_book_reference_not_visible","unsupported_cost_book_uom","cost_uom_conversion_unavailable","cost_book_base_unavailable","cost_book_base_ambiguous","cost_ship_from_location_not_visible","cost_package_quantity_invalid","cost_component_invalid","cost_date_window_invalid","cost_date_overlap","cost_amount_overflow","cost_book_conflict","product_family_reference_active","product_packaging_reference_active","primary_child_available","primary_change_unsupported","reference_visibility_blocked","scope_authorized","stale_record","stale_cost_book_entry","supplier_reference_active","tag_applicable","tag_available","tag_exists","tag_found","tag_not_applicable","tag_not_found","type_immutable","type_known","type_required","target_active","target_available","target_not_found_or_not_visible","targets_visible","unsupported_linked_record","unsupported_profile_shape","variable_qty_valid","validation_failed","value_nonempty"]},"status":{"type":"string","enum":["passed","blocked"]},"message":{"type":"string"},"param":{"type":"string"}},"required":["code","status","message"],"additionalProperties":false}},"duplicateCandidates":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact","customer","supplier","customer_location","customer_address","supplier_ship_from_location","product","product_family","document"]},"readable":{"type":"boolean"},"version":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","product","purchase_order"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"matchReasons":{"type":"array","items":{"type":"string","enum":["name","email","externalId","address","code","product","url"]}},"readbackPath":{"type":"string"}},"required":["type","readable","matchReasons"],"additionalProperties":false}},"idempotency":{"type":"object","properties":{"required":{"type":"boolean"},"keyProvided":{"type":"boolean"},"wouldReplay":{"type":"boolean"}},"required":["required","keyProvided","wouldReplay"],"additionalProperties":false},"wouldChange":{"type":"object","properties":{"fieldNames":{"type":"array","items":{"type":"string"}},"values":{"type":"object","additionalProperties":{}}},"required":["fieldNames","values"],"additionalProperties":false},"impactAnalysis":{"type":"object","properties":{"asOf":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"currentEntry":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"entryType":{"type":"string","enum":["direct","constructed"]}},"required":["id","entryType"],"additionalProperties":false},"normalizedConstruction":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["direct"]},"basis":{"type":"string","enum":["material","landed"]},"uom":{"type":"string","enum":["GALLON","LITER","POUND","KILOGRAM","EACH","METRIC_TON","SHORT_TON"]},"costPerBaseUomCents":{"type":"string"},"rates":{"type":"array","items":{"type":"object","properties":{"costPerBaseUomCents":{"type":"string"},"minimumQuantity":{"type":["string","null"]},"minimumBasis":{"type":["string","null"],"enum":["product_uom","package"]},"minimumProductPackagingId":{"type":["string","null"],"format":"uuid"}},"required":["costPerBaseUomCents"],"additionalProperties":false},"minItems":1,"maxItems":50}},"required":["type","basis","uom"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["constructed"]},"startingCost":{"type":"object","properties":{"source":{"type":"string","enum":["entered"]},"basis":{"type":"string","enum":["material","landed"]},"uom":{"type":"string","enum":["GALLON","LITER","POUND","KILOGRAM","EACH","METRIC_TON","SHORT_TON"]},"costPerBaseUomCents":{"type":"string"}},"required":["source","basis","uom","costPerBaseUomCents"],"additionalProperties":false},"additionalCosts":{"type":"array","items":{"type":"object","properties":{"class":{"type":"string","enum":["FREIGHT","PACKAGING","DUTY","STORAGE","PROCESSING","HANDLING","TAX","OTHER"]},"method":{"type":"string","enum":["percent_of_starting_cost","cents_per_base_uom","cents_per_package"]},"value":{"type":"string"},"description":{"type":["string","null"],"maxLength":500}},"required":["class","method","value"],"additionalProperties":false},"minItems":1,"maxItems":50}},"required":["type","startingCost","additionalCosts"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["constructed"]},"startingCost":{"type":"object","properties":{"source":{"type":"string","enum":["cost_book_entry"]},"productId":{"type":"string","format":"uuid"}},"required":["source","productId"],"additionalProperties":false},"additionalCosts":{"type":"array","items":{"type":"object","properties":{"class":{"type":"string","enum":["FREIGHT","PACKAGING","DUTY","STORAGE","PROCESSING","HANDLING","TAX","OTHER"]},"method":{"type":"string","enum":["percent_of_starting_cost","cents_per_base_uom","cents_per_package"]},"value":{"type":"string"},"description":{"type":["string","null"],"maxLength":500}},"required":["class","method","value"],"additionalProperties":false},"maxItems":50}},"required":["type","startingCost","additionalCosts"],"additionalProperties":false}]},"baseCurrencyCode":{"type":"string"},"predictedEntry":{"type":["object","null"],"properties":{"entryType":{"type":"string","enum":["direct","constructed"]},"construction":{"type":"object","properties":{"type":{"type":"string","enum":["direct","constructed"]},"startingCost":{"type":"object","properties":{"source":{"type":"string","enum":["entered","cost_book_entry"]},"entryId":{"type":["string","null"],"format":"uuid"},"productId":{"type":["string","null"],"format":"uuid"},"basis":{"type":["string","null"],"enum":["material","landed"]},"amount":{"type":"object","properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string"},"uom":{"type":"string","enum":["GALLON","LITER","POUND","KILOGRAM","EACH","METRIC_TON","SHORT_TON"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom"],"additionalProperties":false}},"required":["source","entryId","productId","basis","amount"],"additionalProperties":false},"additionalCosts":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"integer","minimum":0},"class":{"type":"string","enum":["FREIGHT","PACKAGING","DUTY","STORAGE","PROCESSING","HANDLING","TAX","OTHER"]},"method":{"type":"string","enum":["percent_of_starting_cost","cents_per_base_uom","cents_per_package"]},"value":{"type":"string"},"description":{"type":["string","null"]},"resolvedContribution":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string"},"uom":{"type":"string","enum":["GALLON","LITER","POUND","KILOGRAM","EACH","METRIC_TON","SHORT_TON"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom"],"additionalProperties":false}},"required":["sequence","class","method","value","description","resolvedContribution"],"additionalProperties":false}}},"required":["type","startingCost","additionalCosts"],"additionalProperties":false},"additionalCostTotal":{"type":"object","properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string"},"uom":{"type":"string","enum":["GALLON","LITER","POUND","KILOGRAM","EACH","METRIC_TON","SHORT_TON"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom"],"additionalProperties":false},"totalCost":{"type":"object","properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string"},"uom":{"type":"string","enum":["GALLON","LITER","POUND","KILOGRAM","EACH","METRIC_TON","SHORT_TON"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom"],"additionalProperties":false},"completeness":{"type":"object","properties":{"status":{"type":"string","enum":["complete"]},"warningCodes":{"type":"array","items":{"type":"string"}}},"required":["status","warningCodes"],"additionalProperties":false}},"required":["entryType","construction","additionalCostTotal","totalCost","completeness"],"additionalProperties":false},"costContext":{"type":["object","null"],"properties":{"product":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"code":{"type":"string"},"displayName":{"type":"string"},"baseUom":{"type":"string"},"archived":{"type":"boolean","enum":[false]}},"required":["id","code","displayName","baseUom","archived"],"additionalProperties":false},"supplier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"archived":{"type":"boolean","enum":[false]}},"required":["id","displayName","archived"],"additionalProperties":false},"costBookAsOf":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"purchaseEvidenceObservedAt":{"type":"string","format":"date-time"},"currencyCode":{"type":"string","minLength":3,"maxLength":3},"currentCostBookEntry":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"entryType":{"type":"string","enum":["direct","constructed"]},"effectiveFrom":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"effectiveTo":{"type":["string","null"],"pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"cost":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string","minLength":3,"maxLength":3},"uom":{"type":"string"},"comparisonBasis":{"type":"string","enum":["material","landed","unclassified"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom","comparisonBasis"],"additionalProperties":false},"resolutionState":{"type":"string","enum":["resolved","quantity_required","unavailable"]},"completeness":{"type":"string","enum":["complete","unresolved"]},"warningCodes":{"type":"array","items":{"type":"string"}},"rates":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"integer","minimum":0},"amount":{"type":"object","properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string","minLength":3,"maxLength":3},"uom":{"type":"string","minLength":1}},"required":["decimalCentsPerBaseUom","currencyCode","uom"],"additionalProperties":false},"minimumQuantity":{"type":["string","null"]},"minimumBasis":{"type":["string","null"],"enum":["product_uom","package"]},"minimumPackage":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","minLength":1},"quantity":{"type":"string"},"uom":{"type":"string","minLength":1}},"required":["id","name","quantity","uom"],"additionalProperties":false}},"required":["sequence","amount","minimumQuantity","minimumBasis","minimumPackage"],"additionalProperties":false},"maxItems":50}},"required":["id","entryType","effectiveFrom","effectiveTo","cost","resolutionState","completeness","warningCodes","rates"],"additionalProperties":false},"priorCostBookEntry":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"entryType":{"type":"string","enum":["direct","constructed"]},"effectiveFrom":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"effectiveTo":{"type":["string","null"],"pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"cost":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string","minLength":3,"maxLength":3},"uom":{"type":"string"},"comparisonBasis":{"type":"string","enum":["material","landed","unclassified"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom","comparisonBasis"],"additionalProperties":false},"resolutionState":{"type":"string","enum":["resolved","quantity_required","unavailable"]},"completeness":{"type":"string","enum":["complete","unresolved"]},"warningCodes":{"type":"array","items":{"type":"string"}},"rates":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"integer","minimum":0},"amount":{"type":"object","properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string","minLength":3,"maxLength":3},"uom":{"type":"string","minLength":1}},"required":["decimalCentsPerBaseUom","currencyCode","uom"],"additionalProperties":false},"minimumQuantity":{"type":["string","null"]},"minimumBasis":{"type":["string","null"],"enum":["product_uom","package"]},"minimumPackage":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","minLength":1},"quantity":{"type":"string"},"uom":{"type":"string","minLength":1}},"required":["id","name","quantity","uom"],"additionalProperties":false}},"required":["sequence","amount","minimumQuantity","minimumBasis","minimumPackage"],"additionalProperties":false},"maxItems":50}},"required":["id","entryType","effectiveFrom","effectiveTo","cost","resolutionState","completeness","warningCodes","rates"],"additionalProperties":false},"lastCompletedPurchase":{"type":["object","null"],"properties":{"materialCost":{"type":"object","properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string","minLength":3,"maxLength":3},"uom":{"type":"string"},"comparisonBasis":{"type":"string","enum":["material","landed","unclassified"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom","comparisonBasis"],"additionalProperties":false},"landedCost":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string","minLength":3,"maxLength":3},"uom":{"type":"string"},"comparisonBasis":{"type":"string","enum":["material","landed","unclassified"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom","comparisonBasis"],"additionalProperties":false},"sourceDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"observedAt":{"type":"string","format":"date-time"},"status":{"type":"string","enum":["completed","pending"]},"sourceReference":{"type":"string","minLength":1}},"required":["materialCost","landedCost","sourceDate","observedAt","status","sourceReference"],"additionalProperties":false},"latestOnOrderPurchase":{"type":["object","null"],"properties":{"materialCost":{"type":"object","properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string","minLength":3,"maxLength":3},"uom":{"type":"string"},"comparisonBasis":{"type":"string","enum":["material","landed","unclassified"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom","comparisonBasis"],"additionalProperties":false},"landedCost":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string","minLength":3,"maxLength":3},"uom":{"type":"string"},"comparisonBasis":{"type":"string","enum":["material","landed","unclassified"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom","comparisonBasis"],"additionalProperties":false},"sourceDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"observedAt":{"type":"string","format":"date-time"},"status":{"type":"string","enum":["completed","pending"]},"sourceReference":{"type":"string","minLength":1}},"required":["materialCost","landedCost","sourceDate","observedAt","status","sourceReference"],"additionalProperties":false},"comparisons":{"type":"object","properties":{"currentVsPrior":{"type":"object","properties":{"left":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string","minLength":3,"maxLength":3},"uom":{"type":"string"},"comparisonBasis":{"type":"string","enum":["material","landed","unclassified"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom","comparisonBasis"],"additionalProperties":false},"right":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string","minLength":3,"maxLength":3},"uom":{"type":"string"},"comparisonBasis":{"type":"string","enum":["material","landed","unclassified"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom","comparisonBasis"],"additionalProperties":false},"comparable":{"type":"boolean"},"amountDeltaCentsPerBaseUom":{"type":["string","null"]},"percentageDelta":{"type":["string","null"]},"reason":{"type":["string","null"]},"temporalRelation":{"type":["string","null"],"enum":["evidence_precedes_cost_book_as_of","same_day_as_cost_book_as_of","evidence_postdates_cost_book_as_of"]}},"required":["left","right","comparable","amountDeltaCentsPerBaseUom","percentageDelta","reason","temporalRelation"],"additionalProperties":false},"currentVsCompleted":{"type":"object","properties":{"left":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string","minLength":3,"maxLength":3},"uom":{"type":"string"},"comparisonBasis":{"type":"string","enum":["material","landed","unclassified"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom","comparisonBasis"],"additionalProperties":false},"right":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string","minLength":3,"maxLength":3},"uom":{"type":"string"},"comparisonBasis":{"type":"string","enum":["material","landed","unclassified"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom","comparisonBasis"],"additionalProperties":false},"comparable":{"type":"boolean"},"amountDeltaCentsPerBaseUom":{"type":["string","null"]},"percentageDelta":{"type":["string","null"]},"reason":{"type":["string","null"]},"temporalRelation":{"type":["string","null"],"enum":["evidence_precedes_cost_book_as_of","same_day_as_cost_book_as_of","evidence_postdates_cost_book_as_of"]}},"required":["left","right","comparable","amountDeltaCentsPerBaseUom","percentageDelta","reason","temporalRelation"],"additionalProperties":false},"currentVsPending":{"type":"object","properties":{"left":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string","minLength":3,"maxLength":3},"uom":{"type":"string"},"comparisonBasis":{"type":"string","enum":["material","landed","unclassified"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom","comparisonBasis"],"additionalProperties":false},"right":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string","minLength":3,"maxLength":3},"uom":{"type":"string"},"comparisonBasis":{"type":"string","enum":["material","landed","unclassified"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom","comparisonBasis"],"additionalProperties":false},"comparable":{"type":"boolean"},"amountDeltaCentsPerBaseUom":{"type":["string","null"]},"percentageDelta":{"type":["string","null"]},"reason":{"type":["string","null"]},"temporalRelation":{"type":["string","null"],"enum":["evidence_precedes_cost_book_as_of","same_day_as_cost_book_as_of","evidence_postdates_cost_book_as_of"]}},"required":["left","right","comparable","amountDeltaCentsPerBaseUom","percentageDelta","reason","temporalRelation"],"additionalProperties":false}},"required":["currentVsPrior","currentVsCompleted","currentVsPending"],"additionalProperties":false},"expectedCurrentEntryId":{"type":["string","null"],"format":"uuid"},"completeness":{"type":"string","enum":["complete","partial","missing","unresolved"]},"warningCodes":{"type":"array","items":{"type":"string"}},"sourceSelection":{"type":"object","properties":{"resolutionMode":{"type":"string","enum":["explicit","fixed_supplier","current_source","only_available"]},"authorityState":{"type":["string","null"],"enum":["fixed_supplier","current_source","unconfigured","unavailable"]},"resolvedSupplierId":{"type":"string","format":"uuid"},"candidateCount":{"type":"integer","minimum":0},"candidates":{"type":"array","items":{"type":"object","properties":{"supplierId":{"type":"string","format":"uuid"},"supplierName":{"type":"string"},"evidenceSource":{"type":"string","enum":["active_book","construction"]}},"required":["supplierId","supplierName","evidenceSource"],"additionalProperties":false}},"selectionProvenance":{"type":["object","null"],"properties":{"selectedAt":{"type":"string"},"selectedById":{"type":"string","format":"uuid"},"selectedByName":{"type":"string"}},"required":["selectedAt","selectedById","selectedByName"],"additionalProperties":false},"unavailabilityReason":{"type":["string","null"]}},"required":["resolutionMode","authorityState","resolvedSupplierId","candidateCount","candidates","selectionProvenance","unavailabilityReason"],"additionalProperties":false},"proposedCost":{"type":"object","properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string","minLength":3,"maxLength":3},"uom":{"type":"string"},"comparisonBasis":{"type":"string","enum":["material","landed","unclassified"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom","comparisonBasis"],"additionalProperties":false},"proposedComparisons":{"type":"object","properties":{"proposedVsCurrent":{"type":"object","properties":{"left":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string","minLength":3,"maxLength":3},"uom":{"type":"string"},"comparisonBasis":{"type":"string","enum":["material","landed","unclassified"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom","comparisonBasis"],"additionalProperties":false},"right":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string","minLength":3,"maxLength":3},"uom":{"type":"string"},"comparisonBasis":{"type":"string","enum":["material","landed","unclassified"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom","comparisonBasis"],"additionalProperties":false},"comparable":{"type":"boolean"},"amountDeltaCentsPerBaseUom":{"type":["string","null"]},"percentageDelta":{"type":["string","null"]},"reason":{"type":["string","null"]},"temporalRelation":{"type":["string","null"],"enum":["evidence_precedes_cost_book_as_of","same_day_as_cost_book_as_of","evidence_postdates_cost_book_as_of"]}},"required":["left","right","comparable","amountDeltaCentsPerBaseUom","percentageDelta","reason","temporalRelation"],"additionalProperties":false},"proposedVsCompleted":{"type":"object","properties":{"left":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string","minLength":3,"maxLength":3},"uom":{"type":"string"},"comparisonBasis":{"type":"string","enum":["material","landed","unclassified"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom","comparisonBasis"],"additionalProperties":false},"right":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string","minLength":3,"maxLength":3},"uom":{"type":"string"},"comparisonBasis":{"type":"string","enum":["material","landed","unclassified"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom","comparisonBasis"],"additionalProperties":false},"comparable":{"type":"boolean"},"amountDeltaCentsPerBaseUom":{"type":["string","null"]},"percentageDelta":{"type":["string","null"]},"reason":{"type":["string","null"]},"temporalRelation":{"type":["string","null"],"enum":["evidence_precedes_cost_book_as_of","same_day_as_cost_book_as_of","evidence_postdates_cost_book_as_of"]}},"required":["left","right","comparable","amountDeltaCentsPerBaseUom","percentageDelta","reason","temporalRelation"],"additionalProperties":false},"proposedVsPending":{"type":"object","properties":{"left":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string","minLength":3,"maxLength":3},"uom":{"type":"string"},"comparisonBasis":{"type":"string","enum":["material","landed","unclassified"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom","comparisonBasis"],"additionalProperties":false},"right":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string","minLength":3,"maxLength":3},"uom":{"type":"string"},"comparisonBasis":{"type":"string","enum":["material","landed","unclassified"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom","comparisonBasis"],"additionalProperties":false},"comparable":{"type":"boolean"},"amountDeltaCentsPerBaseUom":{"type":["string","null"]},"percentageDelta":{"type":["string","null"]},"reason":{"type":["string","null"]},"temporalRelation":{"type":["string","null"],"enum":["evidence_precedes_cost_book_as_of","same_day_as_cost_book_as_of","evidence_postdates_cost_book_as_of"]}},"required":["left","right","comparable","amountDeltaCentsPerBaseUom","percentageDelta","reason","temporalRelation"],"additionalProperties":false}},"required":["proposedVsCurrent","proposedVsCompleted","proposedVsPending"],"additionalProperties":false}},"required":["product","supplier","costBookAsOf","purchaseEvidenceObservedAt","currencyCode","currentCostBookEntry","priorCostBookEntry","lastCompletedPurchase","latestOnOrderPurchase","comparisons","expectedCurrentEntryId","completeness","warningCodes","sourceSelection","proposedCost","proposedComparisons"],"additionalProperties":false},"warnings":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false}}},"required":["asOf","currentEntry","normalizedConstruction","baseCurrencyCode","predictedEntry","costContext","warnings"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","operation","status","wouldWrite","submit","verification","checks","duplicateCandidates","impactAnalysis","requestId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},"PublicAPICostBookWriteResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["user"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["system"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string","enum":["System User"]}},"required":["type","id","displayName"],"additionalProperties":false}]},"resourceType":{"type":"string","enum":["cost_book_entry"]},"entryType":{"type":"string","enum":["direct","constructed"]},"product":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"code":{"type":"string"},"displayName":{"type":"string"},"archived":{"type":"boolean"},"url":{"type":"string","format":"uri"}},"required":["id","code","displayName","archived","url"],"additionalProperties":false},"supplier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"externalId":{"type":["string","null"]},"archived":{"type":"boolean"},"url":{"type":"string","format":"uri"}},"required":["id","displayName","externalId","archived","url"],"additionalProperties":false},"arrangement":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"kind":{"type":"string","enum":["GENERAL","AT_PICKUP","AT_DESTINATION"]},"isTaught":{"type":"boolean"}},"required":["id","name","kind","isTaught"],"additionalProperties":false},"shipFromLocation":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false},"incoterm":{"type":["string","null"],"enum":["EXW","FCA","FAS","FOB","CFR","CIF","CPT","CIP","DAP","DPU","DDP","None"]},"supplierTerms":{"type":["string","null"]},"rates":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"integer","minimum":0},"amount":{"type":"object","properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string"},"uom":{"type":"string","enum":["GALLON","LITER","POUND","KILOGRAM","EACH","METRIC_TON","SHORT_TON"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom"],"additionalProperties":false},"minimumQuantity":{"type":["string","null"]},"minimumBasis":{"type":["string","null"],"enum":["product_uom","package"]},"minimumPackage":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"quantity":{"type":"string"},"uom":{"type":"string"}},"required":["id","name","quantity","uom"],"additionalProperties":false}},"required":["sequence","amount","minimumQuantity","minimumBasis","minimumPackage"],"additionalProperties":false}},"lineage":{"type":["object","null"],"properties":{"authoredByMode":{"type":["string","null"],"enum":["updateCost","editCost"]},"authoredAt":{"type":["string","null"],"format":"date-time"},"authoredById":{"type":["string","null"],"format":"uuid"},"supersedesEntryId":{"type":["string","null"],"format":"uuid"},"correctsEntryId":{"type":["string","null"],"format":"uuid"},"supersededAt":{"type":["string","null"],"format":"date-time"}},"required":["authoredByMode","authoredAt","authoredById","supersedesEntryId","correctsEntryId","supersededAt"],"additionalProperties":false},"resolutionState":{"type":"string","enum":["resolved","quantity_required","unavailable"]},"effectiveState":{"type":"string","enum":["active","scheduled","expired"]},"versionState":{"type":"string","enum":["current","superseded"]},"claimRole":{"type":"string","enum":["authoritative","supporting","non_authoritative"]},"disposition":{"type":"string","enum":["eligible","dismissed","archived"]},"effectiveFrom":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"effectiveTo":{"type":["string","null"],"pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"construction":{"type":"object","properties":{"type":{"type":"string","enum":["direct","constructed"]},"startingCost":{"anyOf":[{"type":"object","properties":{"source":{"type":"string","enum":["entered"]},"entryId":{"type":["string","null"],"format":"uuid"},"basis":{"type":["string","null"],"enum":["material","landed"]},"amount":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string"},"uom":{"type":"string","enum":["GALLON","LITER","POUND","KILOGRAM","EACH","METRIC_TON","SHORT_TON"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom"],"additionalProperties":false},"provenance":{"type":["object","null"],"properties":{"origin":{"type":"string","enum":["manual","integration","agent","import"]},"sourceRef":{"type":["string","null"]},"verifiedAt":{"type":["string","null"],"format":"date-time"},"verifiedBy":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["id","displayName"],"additionalProperties":false}},"required":["origin","sourceRef","verifiedAt","verifiedBy"],"additionalProperties":false}},"required":["source","entryId","basis","amount","provenance"],"additionalProperties":false},{"type":"object","properties":{"source":{"type":"string","enum":["cost_book_entry"]},"entryId":{"type":["string","null"],"format":"uuid"},"product":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"code":{"type":"string"},"displayName":{"type":"string"},"archived":{"type":"boolean"},"url":{"type":"string","format":"uri"}},"required":["id","code","displayName","archived","url"],"additionalProperties":false},"basis":{"type":["string","null"],"enum":["material","landed"]},"amount":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string"},"uom":{"type":"string","enum":["GALLON","LITER","POUND","KILOGRAM","EACH","METRIC_TON","SHORT_TON"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom"],"additionalProperties":false},"provenance":{"type":["object","null"],"properties":{"origin":{"type":"string","enum":["manual","integration","agent","import"]},"sourceRef":{"type":["string","null"]},"verifiedAt":{"type":["string","null"],"format":"date-time"},"verifiedBy":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["id","displayName"],"additionalProperties":false}},"required":["origin","sourceRef","verifiedAt","verifiedBy"],"additionalProperties":false}},"required":["source","entryId","product","basis","amount","provenance"],"additionalProperties":false}]},"additionalCosts":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"integer","minimum":0},"class":{"type":"string","enum":["FREIGHT","PACKAGING","DUTY","STORAGE","PROCESSING","HANDLING","TAX","OTHER"]},"method":{"type":"string","enum":["percent_of_starting_cost","cents_per_base_uom","cents_per_package"]},"value":{"type":"string"},"description":{"type":["string","null"]},"resolvedContribution":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string"},"uom":{"type":"string","enum":["GALLON","LITER","POUND","KILOGRAM","EACH","METRIC_TON","SHORT_TON"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom"],"additionalProperties":false}},"required":["sequence","class","method","value","description","resolvedContribution"],"additionalProperties":false}}},"required":["type","startingCost","additionalCosts"],"additionalProperties":false},"additionalCostTotal":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string"},"uom":{"type":"string","enum":["GALLON","LITER","POUND","KILOGRAM","EACH","METRIC_TON","SHORT_TON"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom"],"additionalProperties":false},"totalCost":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string"},"uom":{"type":"string","enum":["GALLON","LITER","POUND","KILOGRAM","EACH","METRIC_TON","SHORT_TON"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom"],"additionalProperties":false},"provenance":{"type":"object","properties":{"origin":{"type":"string","enum":["manual","integration","agent","import"]},"sourceRef":{"type":["string","null"]},"verifiedAt":{"type":["string","null"],"format":"date-time"},"verifiedBy":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["id","displayName"],"additionalProperties":false}},"required":["origin","sourceRef","verifiedAt","verifiedBy"],"additionalProperties":false},"completeness":{"type":"object","properties":{"status":{"type":"string","enum":["complete","unresolved"]},"warningCodes":{"type":"array","items":{"type":"string"}}},"required":["status","warningCodes"],"additionalProperties":false},"waitingReason":{"type":"string","description":"Present when a constructed entry has no total because its starting price is not current."},"costBookUrl":{"type":"string","format":"uri"},"idempotencyStatus":{"type":"string","enum":["created","replayed"]},"resultAction":{"type":"string","enum":["created","superseded"]},"warnings":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false}}},"required":["id","createdAt","resourceType","entryType","product","supplier","shipFromLocation","incoterm","supplierTerms","rates","resolutionState","effectiveState","versionState","claimRole","disposition","effectiveFrom","effectiveTo","construction","additionalCostTotal","totalCost","provenance","completeness","costBookUrl","idempotencyStatus","resultAction","warnings"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},"PublicAPICostBookDeleteResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"resultAction":{"type":"string","enum":["deleted"]},"idempotencyStatus":{"type":"string","enum":["created","replayed"]},"warnings":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false}}},"required":["id","resultAction","idempotencyStatus","warnings"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},"PublicAPICostBookDeleteDryRunResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"status":{"type":"string","enum":["ready"]},"operation":{"type":"string","enum":["deleteCost"]},"currentEntryId":{"type":["string","null"],"format":"uuid"},"predictedEntry":{"type":"null"},"removed":{"type":"object","properties":{"prices":{"type":"array","items":{"type":"string","format":"uuid"}},"breakdowns":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["prices","breakdowns"],"additionalProperties":false},"restored":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"dateFrom":{"type":"string","format":"date-time"},"dateTo":{"type":["string","null"],"format":"date-time"}},"required":["id","dateFrom","dateTo"],"additionalProperties":false}},"addedCostCount":{"type":"integer","minimum":0},"survivingBasePrice":{"type":["object","null"],"properties":{"currencyCode":{"type":"string"},"decimalCentsPerBaseUom":{"type":"string"}},"required":["currencyCode","decimalCentsPerBaseUom"],"additionalProperties":false},"confirmation":{"type":"string"}},"required":["status","operation","currentEntryId","predictedEntry","removed","restored","addedCostCount","survivingBasePrice","confirmation"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},"PublicAPICurrentCostSourceResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"authorityState":{"type":"string","enum":["fixed_supplier","current_source","unconfigured","unavailable"]},"authoritativeLane":{"type":["object","null"],"properties":{"productId":{"type":"string","format":"uuid"},"supplierId":{"type":"string","format":"uuid"},"supplierName":{"type":"string"},"shipFromLocationId":{"type":["string","null"],"format":"uuid"},"shipFromLocationName":{"type":["string","null"]},"evidenceSource":{"type":["string","null"],"enum":["active_book","construction"]}},"required":["productId","supplierId","supplierName","shipFromLocationId","shipFromLocationName","evidenceSource"],"additionalProperties":false},"inferredDisplay":{"type":["object","null"],"properties":{"lane":{"type":"object","properties":{"productId":{"type":"string","format":"uuid"},"supplierId":{"type":"string","format":"uuid"},"supplierName":{"type":"string"},"shipFromLocationId":{"type":["string","null"],"format":"uuid"},"shipFromLocationName":{"type":["string","null"]},"costPerBaseUomCents":{"type":["number","null"]},"uom":{"type":["string","null"]},"dateFrom":{"type":"string","format":"date-time"},"evidenceSource":{"type":"string","enum":["active_book","construction"]}},"required":["productId","supplierId","supplierName","shipFromLocationId","shipFromLocationName","costPerBaseUomCents","uom","dateFrom","evidenceSource"],"additionalProperties":false},"selectionReason":{"type":"string","enum":["only_available","most_recent"]},"evidenceSource":{"type":"string","enum":["active_book","construction"]}},"required":["lane","selectionReason","evidenceSource"],"additionalProperties":false},"candidates":{"type":"array","items":{"type":"object","properties":{"productId":{"type":"string","format":"uuid"},"supplierId":{"type":"string","format":"uuid"},"supplierName":{"type":"string"},"shipFromLocationId":{"type":["string","null"],"format":"uuid"},"shipFromLocationName":{"type":["string","null"]},"costPerBaseUomCents":{"type":["number","null"]},"uom":{"type":["string","null"]},"dateFrom":{"type":"string","format":"date-time"},"evidenceSource":{"type":"string","enum":["active_book","construction"]}},"required":["productId","supplierId","supplierName","shipFromLocationId","shipFromLocationName","costPerBaseUomCents","uom","dateFrom","evidenceSource"],"additionalProperties":false}},"locationCandidates":{"type":"array","items":{"type":"object","properties":{"productId":{"type":"string","format":"uuid"},"supplierId":{"type":"string","format":"uuid"},"supplierName":{"type":"string"},"shipFromLocationId":{"type":["string","null"],"format":"uuid"},"shipFromLocationName":{"type":["string","null"]},"costPerBaseUomCents":{"type":["number","null"]},"uom":{"type":["string","null"]},"dateFrom":{"type":"string","format":"date-time"},"evidenceSource":{"type":"string","enum":["active_book","construction"]}},"required":["productId","supplierId","supplierName","shipFromLocationId","shipFromLocationName","costPerBaseUomCents","uom","dateFrom","evidenceSource"],"additionalProperties":false}},"candidateCount":{"type":"integer","minimum":0},"supplierCandidateCount":{"type":"integer","minimum":0},"selectionProvenance":{"type":["object","null"],"properties":{"selectedAt":{"type":"string","format":"date-time"},"selectedById":{"type":"string","format":"uuid"},"selectedByName":{"type":"string"}},"required":["selectedAt","selectedById","selectedByName"],"additionalProperties":false},"unavailableSupplierId":{"type":["string","null"],"format":"uuid"},"unavailableSupplierName":{"type":["string","null"]},"unavailableShipFromLocationId":{"type":["string","null"],"format":"uuid"},"unavailableShipFromLocationName":{"type":["string","null"]},"unavailabilityReason":{"type":["string","null"]}},"required":["authorityState","authoritativeLane","inferredDisplay","candidates","locationCandidates","candidateCount","supplierCandidateCount","selectionProvenance","unavailableSupplierId","unavailableSupplierName","unavailableShipFromLocationId","unavailableShipFromLocationName","unavailabilityReason"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},"PublicAPICurrentCostSourceDryRunResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"status":{"type":"string","enum":["ready"]},"operation":{"type":"string","enum":["current_cost_sources.put"]},"dryRun":{"type":"boolean","enum":[true]},"desiredSupplierId":{"type":["string","null"],"format":"uuid"},"desiredShipFromLocationId":{"type":["string","null"],"format":"uuid"},"previousSupplierId":{"type":["string","null"],"format":"uuid"},"previousShipFromLocationId":{"type":["string","null"],"format":"uuid"},"consequence":{"type":"string","enum":["set","replace","clear","unchanged"]},"eligibility":{"type":"object","properties":{"ready":{"type":"boolean","enum":[true]},"candidateCount":{"type":"integer","minimum":0}},"required":["ready","candidateCount"],"additionalProperties":false},"verification":{"type":"object","properties":{"method":{"type":"string","enum":["GET"]},"path":{"type":"string"}},"required":["method","path"],"additionalProperties":false}},"required":["status","operation","dryRun","desiredSupplierId","desiredShipFromLocationId","previousSupplierId","previousShipFromLocationId","consequence","eligibility","verification"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},"PublicAPICurrentCostSourceWriteResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"status":{"type":"string","enum":["updated","unchanged"]},"dryRun":{"type":"boolean","enum":[false]},"outcome":{"type":"string","enum":["set","replace","clear","unchanged"]},"previousSupplierId":{"type":["string","null"],"format":"uuid"},"previousShipFromLocationId":{"type":["string","null"],"format":"uuid"},"current":{"type":"object","properties":{"authorityState":{"type":"string","enum":["fixed_supplier","current_source","unconfigured","unavailable"]},"authoritativeLane":{"type":["object","null"],"properties":{"productId":{"type":"string","format":"uuid"},"supplierId":{"type":"string","format":"uuid"},"supplierName":{"type":"string"},"shipFromLocationId":{"type":["string","null"],"format":"uuid"},"shipFromLocationName":{"type":["string","null"]},"evidenceSource":{"type":["string","null"],"enum":["active_book","construction"]}},"required":["productId","supplierId","supplierName","shipFromLocationId","shipFromLocationName","evidenceSource"],"additionalProperties":false},"inferredDisplay":{"type":["object","null"],"properties":{"lane":{"type":"object","properties":{"productId":{"type":"string","format":"uuid"},"supplierId":{"type":"string","format":"uuid"},"supplierName":{"type":"string"},"shipFromLocationId":{"type":["string","null"],"format":"uuid"},"shipFromLocationName":{"type":["string","null"]},"costPerBaseUomCents":{"type":["number","null"]},"uom":{"type":["string","null"]},"dateFrom":{"type":"string","format":"date-time"},"evidenceSource":{"type":"string","enum":["active_book","construction"]}},"required":["productId","supplierId","supplierName","shipFromLocationId","shipFromLocationName","costPerBaseUomCents","uom","dateFrom","evidenceSource"],"additionalProperties":false},"selectionReason":{"type":"string","enum":["only_available","most_recent"]},"evidenceSource":{"type":"string","enum":["active_book","construction"]}},"required":["lane","selectionReason","evidenceSource"],"additionalProperties":false},"candidates":{"type":"array","items":{"type":"object","properties":{"productId":{"type":"string","format":"uuid"},"supplierId":{"type":"string","format":"uuid"},"supplierName":{"type":"string"},"shipFromLocationId":{"type":["string","null"],"format":"uuid"},"shipFromLocationName":{"type":["string","null"]},"costPerBaseUomCents":{"type":["number","null"]},"uom":{"type":["string","null"]},"dateFrom":{"type":"string","format":"date-time"},"evidenceSource":{"type":"string","enum":["active_book","construction"]}},"required":["productId","supplierId","supplierName","shipFromLocationId","shipFromLocationName","costPerBaseUomCents","uom","dateFrom","evidenceSource"],"additionalProperties":false}},"locationCandidates":{"type":"array","items":{"type":"object","properties":{"productId":{"type":"string","format":"uuid"},"supplierId":{"type":"string","format":"uuid"},"supplierName":{"type":"string"},"shipFromLocationId":{"type":["string","null"],"format":"uuid"},"shipFromLocationName":{"type":["string","null"]},"costPerBaseUomCents":{"type":["number","null"]},"uom":{"type":["string","null"]},"dateFrom":{"type":"string","format":"date-time"},"evidenceSource":{"type":"string","enum":["active_book","construction"]}},"required":["productId","supplierId","supplierName","shipFromLocationId","shipFromLocationName","costPerBaseUomCents","uom","dateFrom","evidenceSource"],"additionalProperties":false}},"candidateCount":{"type":"integer","minimum":0},"supplierCandidateCount":{"type":"integer","minimum":0},"selectionProvenance":{"type":["object","null"],"properties":{"selectedAt":{"type":"string","format":"date-time"},"selectedById":{"type":"string","format":"uuid"},"selectedByName":{"type":"string"}},"required":["selectedAt","selectedById","selectedByName"],"additionalProperties":false},"unavailableSupplierId":{"type":["string","null"],"format":"uuid"},"unavailableSupplierName":{"type":["string","null"]},"unavailableShipFromLocationId":{"type":["string","null"],"format":"uuid"},"unavailableShipFromLocationName":{"type":["string","null"]},"unavailabilityReason":{"type":["string","null"]}},"required":["authorityState","authoritativeLane","inferredDisplay","candidates","locationCandidates","candidateCount","supplierCandidateCount","selectionProvenance","unavailableSupplierId","unavailableSupplierName","unavailableShipFromLocationId","unavailableShipFromLocationName","unavailabilityReason"],"additionalProperties":false},"provenance":{"type":["object","null"],"properties":{"selectedAt":{"type":"string","format":"date-time"},"selectedById":{"type":"string","format":"uuid"},"selectedByName":{"type":"string"}},"required":["selectedAt","selectedById","selectedByName"],"additionalProperties":false},"verification":{"type":"object","properties":{"method":{"type":"string","enum":["GET"]},"path":{"type":"string"}},"required":["method","path"],"additionalProperties":false}},"required":["status","dryRun","outcome","previousSupplierId","previousShipFromLocationId","current","provenance","verification"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},"PublicAPIWriteReadinessResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["write_readiness"]},"operation":{"type":"string","enum":["warehouses.create","warehouses.update","warehouses.archive","warehouses.unarchive","shipping_options.create","shipping_options.update","shipping_options.archive","shipping_options.unarchive","reorder_points.create","tags.create","tags.update","tag_assignments.create","tag_assignments.delete","notes.create","notes.update","opportunities.create","opportunities.update","opportunities.close","opportunities.meta-upsert","contacts.create","contacts.update","customers.create","customers.update","customer_locations.create","customer_locations.update","customer_addresses.create","customer_addresses.update","suppliers.create","suppliers.update","supplier_ship_from_locations.create","supplier_ship_from_locations.update","products.create","products.update","products.archive","products.unarchive","product_packaging.create","products.suppliers.create","products.suppliers.delete","products.aliases.create","products.aliases.update","products.aliases.delete","product_families.aliases.create","product_families.aliases.update","product_families.aliases.delete","products.customer_part_numbers.create","products.customer_part_numbers.update","products.customer_part_numbers.delete","product_sds.update","product_documents.create","customer_documents.create","supplier_documents.create","purchase_order_documents.create","product_families.create","product_families.update","cost_book_entries.create","current_cost_sources.put","customers.archive","customers.unarchive","suppliers.archive","suppliers.unarchive","contacts.archive","contacts.unarchive","customer_addresses.archive","customer_addresses.unarchive","supplier_ship_from_locations.archive","supplier_ship_from_locations.unarchive","representatives.create","representatives.update","representatives.archive","representatives.unarchive","payment_terms.create","payment_terms.update","ledger_accounts.create","ledger_accounts.update"]},"status":{"type":"string","enum":["ready","blocked"]},"wouldWrite":{"type":"boolean","enum":[false]},"submit":{"type":"object","properties":{"method":{"type":"string","enum":["POST","PATCH","PUT","DELETE"]},"path":{"type":"string"},"query":{"type":"object","properties":{},"additionalProperties":false}},"required":["method","path","query"],"additionalProperties":false},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false},"checks":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["not_direct_ship","address_role_required","address_role_valid","already_assigned","already_exists","active_duplicate","ambiguous_external_id","ambiguous_natural_key","api_created","archived_target","archived_record","archive_blocked","account_type_locked","duplicate_candidate_found","duplicate_candidate_overflow","duplicate_check_clear","duplicate_check_not_needed","duplicate_contact","duplicate_customer","duplicate_customer_address","duplicate_customer_location","duplicate_note","duplicate_resolution_applied","duplicate_supplier","duplicate_supplier_ship_from_location","document_url_org_scoped","document_url_valid","upload_verified","sds_converged","idempotency_available","idempotency_key_required","idempotency_key_reused","idempotency_replay","idempotency_target_missing","income_statement_type_invalid","hard_identity_clear","nested_external_id_clear","commercial_references_valid","credit_denomination_mismatch","customer_service_representative_reference_active","ledger_account_reference_valid","payment_terms_reference_exists","sales_person_reference_active","supplier_representative_reference_active","duplicate_reference_identity","external_id_conflict","if_match_current","base_uom_transition_allowed","base_uom_transition_blocked","attribute_assignments_valid","attribute_assignments_invalid","selected_supplier_link","linked_records_available","natural_key_conflict","not_api_created","no_downstream_mutation","order_sensitive_update_allowed","order_sensitive_update_blocked","parent_available","cost_book_entry_blocked","cost_book_entry_valid","cost_book_reference_not_visible","unsupported_cost_book_uom","cost_uom_conversion_unavailable","cost_book_base_unavailable","cost_book_base_ambiguous","cost_ship_from_location_not_visible","cost_package_quantity_invalid","cost_component_invalid","cost_date_window_invalid","cost_date_overlap","cost_amount_overflow","cost_book_conflict","product_family_reference_active","product_packaging_reference_active","primary_child_available","primary_change_unsupported","reference_visibility_blocked","scope_authorized","stale_record","stale_cost_book_entry","supplier_reference_active","tag_applicable","tag_available","tag_exists","tag_found","tag_not_applicable","tag_not_found","type_immutable","type_known","type_required","target_active","target_available","target_not_found_or_not_visible","targets_visible","unsupported_linked_record","unsupported_profile_shape","variable_qty_valid","validation_failed","value_nonempty"]},"status":{"type":"string","enum":["passed","blocked"]},"message":{"type":"string"},"param":{"type":"string"}},"required":["code","status","message"],"additionalProperties":false}},"duplicateCandidates":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact","customer","supplier","customer_location","customer_address","supplier_ship_from_location","product","product_family","document"]},"readable":{"type":"boolean"},"version":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","product","purchase_order"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"matchReasons":{"type":"array","items":{"type":"string","enum":["name","email","externalId","address","code","product","url"]}},"readbackPath":{"type":"string"}},"required":["type","readable","matchReasons"],"additionalProperties":false}},"idempotency":{"type":"object","properties":{"required":{"type":"boolean"},"keyProvided":{"type":"boolean"},"wouldReplay":{"type":"boolean"}},"required":["required","keyProvided","wouldReplay"],"additionalProperties":false},"wouldChange":{"type":"object","properties":{"fieldNames":{"type":"array","items":{"type":"string"}},"values":{"type":"object","additionalProperties":{}}},"required":["fieldNames","values"],"additionalProperties":false},"impactAnalysis":{"type":"object","additionalProperties":{}},"requestId":{"type":"string"}},"required":["type","operation","status","wouldWrite","submit","verification","checks","duplicateCandidates","requestId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},"PublicAPIRepresentativeResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"kind":{"type":"string","enum":["salesperson","customer_service","supplier"]},"id":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":["string","null"]},"name":{"type":"string"},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"},"active":{"type":"boolean"},"updatedAt":{"type":"string","format":"date-time"},"linkedUserId":{"type":["string","null"],"format":"uuid"},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"emailProvenance":{"type":"string","enum":["representative","linked_user","unavailable"]},"type":{"type":"string","enum":["representative"]},"idempotencyStatus":{"type":"string","enum":["created","replayed"]}},"required":["kind","id","firstName","lastName","name","externalId","archivedAt","active","updatedAt","linkedUserId","email","phone","emailProvenance","type"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},"PublicAPIRepresentativeListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["salesperson","customer_service","supplier"]},"id":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":["string","null"]},"name":{"type":"string"},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"},"active":{"type":"boolean"},"updatedAt":{"type":"string","format":"date-time"},"linkedUserId":{"type":["string","null"],"format":"uuid"},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"emailProvenance":{"type":"string","enum":["representative","linked_user","unavailable"]},"type":{"type":"string","enum":["representative"]}},"required":["kind","id","firstName","lastName","name","externalId","archivedAt","active","updatedAt","linkedUserId","email","phone","emailProvenance","type"],"additionalProperties":false}},"meta":{"type":"object","properties":{"limit":{"type":"integer"},"returnedRecords":{"type":"integer"},"populationCount":{"type":"integer"},"complete":{"type":"boolean"},"hasMore":{"type":"boolean"},"nextCursor":{"type":["string","null"]},"ordering":{"type":"string","enum":["name_id"]},"currentState":{"type":"boolean","enum":[true]},"snapshotIsolatedAcrossRequests":{"type":"boolean","enum":[false]}},"required":["limit","returnedRecords","populationCount","complete","hasMore","nextCursor","ordering","currentState","snapshotIsolatedAcrossRequests"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false},"PublicAPIPaymentTermResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string"},"externalId":{"type":["string","null"]},"netDays":{"type":"integer","minimum":0},"discountDays":{"type":["integer","null"],"minimum":0},"discountPercentage":{"type":["string","null"]},"updatedAt":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["payment_term"]},"idempotencyStatus":{"type":"string","enum":["created","replayed"]}},"required":["id","name","description","externalId","netDays","discountDays","discountPercentage","updatedAt","type"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},"PublicAPIPaymentTermListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string"},"externalId":{"type":["string","null"]},"netDays":{"type":"integer","minimum":0},"discountDays":{"type":["integer","null"],"minimum":0},"discountPercentage":{"type":["string","null"]},"updatedAt":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["payment_term"]}},"required":["id","name","description","externalId","netDays","discountDays","discountPercentage","updatedAt","type"],"additionalProperties":false}},"meta":{"type":"object","properties":{"limit":{"type":"integer"},"returnedRecords":{"type":"integer"},"populationCount":{"type":"integer"},"complete":{"type":"boolean"},"hasMore":{"type":"boolean"},"nextCursor":{"type":["string","null"]},"ordering":{"type":"string","enum":["name_id"]},"currentState":{"type":"boolean","enum":[true]},"snapshotIsolatedAcrossRequests":{"type":"boolean","enum":[false]}},"required":["limit","returnedRecords","populationCount","complete","hasMore","nextCursor","ordering","currentState","snapshotIsolatedAcrossRequests"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false},"PublicAPILedgerAccountListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"externalId":{"type":["string","null"]},"accountType":{"type":"string","enum":["ASSET","LIABILITY","EQUITY","REVENUE","EXPENSE"]},"fragmentPath":{"type":["string","null"]},"excludeFromReports":{"type":"boolean"},"isCogs":{"type":"boolean"},"isNonOperational":{"type":"boolean"},"updatedAt":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ledger_account"]}},"required":["id","name","externalId","accountType","fragmentPath","excludeFromReports","isCogs","isNonOperational","updatedAt","type"],"additionalProperties":false}},"meta":{"type":"object","properties":{"limit":{"type":"integer"},"returnedRecords":{"type":"integer"},"populationCount":{"type":"integer"},"complete":{"type":"boolean"},"hasMore":{"type":"boolean"},"nextCursor":{"type":["string","null"]},"ordering":{"type":"string","enum":["name_id"]},"currentState":{"type":"boolean","enum":[true]},"snapshotIsolatedAcrossRequests":{"type":"boolean","enum":[false]}},"required":["limit","returnedRecords","populationCount","complete","hasMore","nextCursor","ordering","currentState","snapshotIsolatedAcrossRequests"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false},"PublicAPILedgerAccountResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"externalId":{"type":["string","null"]},"accountType":{"type":"string","enum":["ASSET","LIABILITY","EQUITY","REVENUE","EXPENSE"]},"fragmentPath":{"type":["string","null"]},"excludeFromReports":{"type":"boolean"},"isCogs":{"type":"boolean"},"isNonOperational":{"type":"boolean"},"updatedAt":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ledger_account"]},"categoryId":{"type":["string","null"],"format":"uuid"},"changed":{"type":"boolean"},"idempotencyStatus":{"type":"string","enum":["created","replayed"]}},"required":["id","name","externalId","accountType","fragmentPath","excludeFromReports","isCogs","isNonOperational","updatedAt","type","categoryId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},"PublicAPILifecycleReceipt":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["lifecycle_receipt"]},"resource":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","customer_contact","supplier_contact","customer_address","supplier_ship_from_location","representative","product","warehouse","shipping_option"]},"kind":{"type":"string","enum":["salesperson","customer_service","supplier"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},"action":{"type":"string","enum":["archive","unarchive"]},"archived":{"type":"boolean"},"changed":{"type":"boolean"},"updatedAt":{"type":"string","format":"date-time"},"requestId":{"type":"string"},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false}},"required":["type","resource","action","archived","changed","updatedAt","requestId","verification"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},"OpenAPIDocument":{"type":"object","properties":{"openapi":{"type":"string"},"info":{"type":"object","properties":{"title":{"type":"string"},"version":{"type":"string"}},"required":["title","version"],"additionalProperties":false}},"required":["openapi","info"],"additionalProperties":false},"ShippingOption":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["SO_FREIGHT_TERMS","PO_FREIGHT_TERMS","SO_SHIPPING_CARRIER","SO_SHIPPING_FOB","SO_FREIGHT_METHOD","BORDER_CROSSING_POINT"]},"value":{"type":"string"},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","type","value","externalId","archivedAt","updatedAt"],"additionalProperties":false},"ShippingOptionType":{"type":"string","enum":["SO_FREIGHT_TERMS","PO_FREIGHT_TERMS","SO_SHIPPING_CARRIER","SO_SHIPPING_FOB","SO_FREIGHT_METHOD","BORDER_CROSSING_POINT"]},"ShippingOptionCreateRequest":{"type":"object","properties":{"type":{"type":"string","enum":["SO_FREIGHT_TERMS","PO_FREIGHT_TERMS","SO_SHIPPING_CARRIER","SO_SHIPPING_FOB","SO_FREIGHT_METHOD","BORDER_CROSSING_POINT"]},"value":{"type":"string","minLength":1},"externalId":{"type":["string","null"],"maxLength":120}},"required":["type","value"],"additionalProperties":false},"ShippingOptionUpdateRequest":{"type":"object","properties":{"value":{"type":"string","minLength":1},"externalId":{"type":["string","null"],"maxLength":120}},"additionalProperties":false},"PublicAPICreateNoteRequest":{"type":"object","properties":{"primarySubject":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","product"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},"linkedRecords":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","product","contact","location","user"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},"maxItems":50,"default":[]},"noteType":{"type":"string","enum":["PHONE_MEETING","PHYSICAL_MEETING","VIRTUAL_MEETING","NOTE","EMAIL","SAMPLE_REQUEST","OPPORTUNITY","QUOTE"]},"title":{"type":"string","minLength":1,"maxLength":240},"body":{"type":"string","minLength":1,"maxLength":20000},"happenedAt":{"type":"string","format":"date-time"},"externalId":{"type":["string","null"],"maxLength":120}},"required":["primarySubject","noteType","title","body","happenedAt"],"additionalProperties":false},"PublicAPIUpdateNoteRequest":{"type":"object","properties":{"linkedRecords":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","product","contact","location","user"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},"maxItems":50},"noteType":{"type":"string","enum":["PHONE_MEETING","PHYSICAL_MEETING","VIRTUAL_MEETING","NOTE","EMAIL","SAMPLE_REQUEST","OPPORTUNITY","QUOTE"]},"title":{"type":"string","minLength":1,"maxLength":240},"body":{"type":"string","minLength":1,"maxLength":20000},"happenedAt":{"type":"string","format":"date-time"},"externalId":{"type":["string","null"],"maxLength":120}},"additionalProperties":false},"PublicAPIListNotesQuery":{"type":"object","properties":{"primarySubjectType":{"type":"string","enum":["customer","supplier","product"]},"primarySubjectId":{"type":"string","format":"uuid"},"happenedAtFrom":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"happenedAtTo":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"noteType":{"type":"string","enum":["PHONE_MEETING","PHYSICAL_MEETING","VIRTUAL_MEETING","NOTE","EMAIL","SAMPLE_REQUEST","OPPORTUNITY","QUOTE"]},"externalId":{"type":"string","minLength":1,"maxLength":120},"limit":{"type":"string"}},"required":["primarySubjectType","primarySubjectId"],"additionalProperties":false},"PublicAPICreateContactRequest":{"type":"object","properties":{"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},"name":{"type":"string","minLength":1,"maxLength":160},"title":{"type":["string","null"],"maxLength":160},"email":{"type":["string","null"],"maxLength":240,"format":"email"},"phone":{"type":["string","null"],"maxLength":80},"mobilePhone":{"type":["string","null"],"maxLength":80},"faxNumber":{"type":["string","null"],"maxLength":80},"isEmergency":{"type":"boolean"},"documentTypes":{"type":"array","items":{"anyOf":[{"type":"string","enum":["AR_LETTER","PRICE_QUOTE","SALES_CONFIRMATION","INVOICE","CREDIT_NOTE"]},{"type":"string","enum":["PURCHASE_ORDERS","BILLS","MARKETING","LOGISTICS","WAREHOUSE","CALL_REPORTS"]}]},"maxItems":10},"externalId":{"type":["string","null"],"maxLength":120},"duplicateResolution":{"type":"string","enum":["create_distinct"]}},"required":["parent","name"],"additionalProperties":false},"PublicAPIUpdateContactRequest":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":160},"title":{"type":["string","null"],"maxLength":160},"email":{"type":["string","null"],"maxLength":240,"format":"email"},"phone":{"type":["string","null"],"maxLength":80},"mobilePhone":{"type":["string","null"],"maxLength":80},"faxNumber":{"type":["string","null"],"maxLength":80},"isEmergency":{"type":"boolean"},"documentTypes":{"type":"array","items":{"anyOf":[{"type":"string","enum":["AR_LETTER","PRICE_QUOTE","SALES_CONFIRMATION","INVOICE","CREDIT_NOTE"]},{"type":"string","enum":["PURCHASE_ORDERS","BILLS","MARKETING","LOGISTICS","WAREHOUSE","CALL_REPORTS"]}]},"maxItems":10},"externalId":{"type":["string","null"],"maxLength":120}},"additionalProperties":false},"PublicAPIListContactsQuery":{"type":"object","properties":{"parentType":{"type":"string","enum":["customer","supplier"]},"parentId":{"type":"string","format":"uuid"},"q":{"type":"string","minLength":2,"maxLength":120},"externalId":{"type":"string","minLength":1,"maxLength":120},"limit":{"type":"string"},"includeArchived":{"type":"string","enum":["true","false"]}},"required":["parentType","parentId"],"additionalProperties":false},"PublicAPICreateCustomerProfileRequest":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":160},"externalId":{"type":["string","null"],"maxLength":120},"pipelineStatus":{"type":"string","enum":["ACTIVE","PROSPECT"],"default":"PROSPECT"},"primaryLocation":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":160},"email":{"type":["string","null"],"maxLength":240},"website":{"type":["string","null"],"maxLength":240},"phone":{"type":["string","null"],"maxLength":80},"accountOwnerId":{"type":["string","null"],"format":"uuid"},"paymentTermsId":{"type":["string","null"],"format":"uuid"},"customerServiceRepresentativeId":{"type":["string","null"],"format":"uuid"},"creditLimit":{"type":["object","null"],"properties":{"amountCents":{"type":["integer","null"],"minimum":0,"maximum":2147483647},"currencyCode":{"type":"string","minLength":3,"maxLength":3}},"required":["amountCents"],"additionalProperties":false},"address":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":160},"street1":{"type":["string","null"],"maxLength":240},"street2":{"type":["string","null"],"maxLength":240},"city":{"type":["string","null"],"maxLength":120},"state":{"type":["string","null"],"maxLength":80},"zip":{"type":["string","null"],"maxLength":40},"country":{"type":["string","null"],"maxLength":80},"email":{"type":["string","null"],"maxLength":240},"phone":{"type":["string","null"],"maxLength":80},"defaultOrderShippingRemarks":{"type":["string","null"],"maxLength":2000},"externalId":{"type":["string","null"],"maxLength":120},"isBilling":{"type":"boolean"},"isShipping":{"type":"boolean"}},"additionalProperties":false}},"additionalProperties":false},"duplicateResolution":{"type":"string","enum":["create_distinct"]}},"required":["name"],"additionalProperties":false},"PublicAPIUpdateCustomerProfileRequest":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":160},"externalId":{"type":["string","null"],"maxLength":120},"pipelineStatus":{"type":"string","enum":["ACTIVE","PROSPECT"]},"primaryLocation":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":160},"email":{"type":["string","null"],"maxLength":240},"website":{"type":["string","null"],"maxLength":240},"phone":{"type":["string","null"],"maxLength":80},"accountOwnerId":{"type":["string","null"],"format":"uuid"},"paymentTermsId":{"type":["string","null"],"format":"uuid"},"customerServiceRepresentativeId":{"type":["string","null"],"format":"uuid"},"creditLimit":{"type":["object","null"],"properties":{"amountCents":{"type":["integer","null"],"minimum":0,"maximum":2147483647},"currencyCode":{"type":"string","minLength":3,"maxLength":3}},"required":["amountCents"],"additionalProperties":false},"address":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":160},"street1":{"type":["string","null"],"maxLength":240},"street2":{"type":["string","null"],"maxLength":240},"city":{"type":["string","null"],"maxLength":120},"state":{"type":["string","null"],"maxLength":80},"zip":{"type":["string","null"],"maxLength":40},"country":{"type":["string","null"],"maxLength":80},"email":{"type":["string","null"],"maxLength":240},"phone":{"type":["string","null"],"maxLength":80},"defaultOrderShippingRemarks":{"type":["string","null"],"maxLength":2000},"externalId":{"type":["string","null"],"maxLength":120},"isBilling":{"type":"boolean"},"isShipping":{"type":"boolean"}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"PublicAPICreateCustomerLocationRequest":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":160},"email":{"type":["string","null"],"maxLength":240},"website":{"type":["string","null"],"maxLength":240},"phone":{"type":["string","null"],"maxLength":80},"accountOwnerId":{"type":["string","null"],"format":"uuid"},"paymentTermsId":{"type":["string","null"],"format":"uuid"},"customerServiceRepresentativeId":{"type":["string","null"],"format":"uuid"},"creditLimit":{"type":["object","null"],"properties":{"amountCents":{"type":["integer","null"],"minimum":0,"maximum":2147483647},"currencyCode":{"type":"string","minLength":3,"maxLength":3}},"required":["amountCents"],"additionalProperties":false},"address":{"type":"object","properties":{"street1":{"type":["string","null"],"maxLength":240},"street2":{"type":["string","null"],"maxLength":240},"city":{"type":["string","null"],"maxLength":120},"state":{"type":["string","null"],"maxLength":80},"zip":{"type":["string","null"],"maxLength":40},"country":{"type":["string","null"],"maxLength":80},"name":{"type":"string","minLength":1,"maxLength":160},"externalId":{"type":["string","null"],"maxLength":120},"email":{"type":["string","null"],"maxLength":240},"phone":{"type":["string","null"],"maxLength":80},"isBilling":{"type":"boolean","default":false},"isShipping":{"type":"boolean","default":false},"defaultOrderShippingRemarks":{"type":["string","null"],"maxLength":2000}},"required":["name"],"additionalProperties":false},"duplicateResolution":{"type":"string","enum":["create_distinct"]}},"required":["name","address"],"additionalProperties":false},"PublicAPIUpdateCustomerLocationRequest":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":160},"email":{"type":["string","null"],"maxLength":240},"website":{"type":["string","null"],"maxLength":240},"phone":{"type":["string","null"],"maxLength":80},"accountOwnerId":{"type":["string","null"],"format":"uuid"},"paymentTermsId":{"type":["string","null"],"format":"uuid"},"customerServiceRepresentativeId":{"type":["string","null"],"format":"uuid"},"creditLimit":{"type":["object","null"],"properties":{"amountCents":{"type":["integer","null"],"minimum":0,"maximum":2147483647},"currencyCode":{"type":"string","minLength":3,"maxLength":3}},"required":["amountCents"],"additionalProperties":false},"primary":{"type":"boolean"},"makePrimary":{"type":"boolean"}},"additionalProperties":false},"PublicAPICreateCustomerAddressRequest":{"type":"object","properties":{"street1":{"type":["string","null"],"maxLength":240},"street2":{"type":["string","null"],"maxLength":240},"city":{"type":["string","null"],"maxLength":120},"state":{"type":["string","null"],"maxLength":80},"zip":{"type":["string","null"],"maxLength":40},"country":{"type":["string","null"],"maxLength":80},"name":{"type":"string","minLength":1,"maxLength":160},"externalId":{"type":["string","null"],"maxLength":120},"email":{"type":["string","null"],"maxLength":240},"phone":{"type":["string","null"],"maxLength":80},"isBilling":{"type":"boolean","default":false},"isShipping":{"type":"boolean","default":false},"defaultOrderShippingRemarks":{"type":["string","null"],"maxLength":2000},"duplicateResolution":{"type":"string","enum":["create_distinct"]}},"required":["name"],"additionalProperties":false},"PublicAPIUpdateCustomerAddressRequest":{"type":"object","properties":{"street1":{"type":["string","null"],"maxLength":240},"street2":{"type":["string","null"],"maxLength":240},"city":{"type":["string","null"],"maxLength":120},"state":{"type":["string","null"],"maxLength":80},"zip":{"type":["string","null"],"maxLength":40},"country":{"type":["string","null"],"maxLength":80},"name":{"type":"string","minLength":1,"maxLength":160},"externalId":{"type":["string","null"],"maxLength":120},"email":{"type":["string","null"],"maxLength":240},"phone":{"type":["string","null"],"maxLength":80},"isBilling":{"type":"boolean"},"isShipping":{"type":"boolean"},"defaultOrderShippingRemarks":{"type":["string","null"],"maxLength":2000}},"additionalProperties":false},"PublicAPICreateSupplierProfileRequest":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":160},"externalId":{"type":["string","null"],"maxLength":120},"phone":{"type":["string","null"],"maxLength":80},"email":{"type":["string","null"],"maxLength":240},"website":{"type":["string","null"],"maxLength":240},"street1":{"type":["string","null"],"maxLength":240},"street2":{"type":["string","null"],"maxLength":240},"city":{"type":["string","null"],"maxLength":120},"state":{"type":["string","null"],"maxLength":80},"zip":{"type":["string","null"],"maxLength":40},"country":{"type":["string","null"],"maxLength":80},"taxId":{"type":["string","null"],"maxLength":120},"paymentTermsId":{"type":["string","null"],"format":"uuid"},"creditLimit":{"type":["object","null"],"properties":{"amountCents":{"type":["integer","null"],"minimum":0,"maximum":2147483647},"currencyCode":{"type":"string","minLength":3,"maxLength":3}},"required":["amountCents"],"additionalProperties":false},"preferredUnitOfMeasure":{"type":"string","enum":["NoPreference","Metric","Imperial"]},"costLedgerAccountId":{"type":["string","null"],"format":"uuid"},"supplierRepresentativeId":{"type":["string","null"],"format":"uuid"},"primaryShipFromAddress":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":160},"externalId":{"type":["string","null"],"maxLength":120},"street1":{"type":["string","null"],"maxLength":240},"street2":{"type":["string","null"],"maxLength":240},"city":{"type":["string","null"],"maxLength":120},"state":{"type":["string","null"],"maxLength":80},"zip":{"type":["string","null"],"maxLength":40},"country":{"type":["string","null"],"maxLength":80},"email":{"type":["string","null"],"maxLength":240},"phone":{"type":["string","null"],"maxLength":80},"defaultSupplierShippingInstructions":{"type":["string","null"],"maxLength":2000}},"additionalProperties":false},"duplicateResolution":{"type":"string","enum":["create_distinct"]}},"required":["name"],"additionalProperties":false},"PublicAPIUpdateSupplierProfileRequest":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":160},"externalId":{"type":["string","null"],"maxLength":120},"phone":{"type":["string","null"],"maxLength":80},"email":{"type":["string","null"],"maxLength":240},"website":{"type":["string","null"],"maxLength":240},"street1":{"type":["string","null"],"maxLength":240},"street2":{"type":["string","null"],"maxLength":240},"city":{"type":["string","null"],"maxLength":120},"state":{"type":["string","null"],"maxLength":80},"zip":{"type":["string","null"],"maxLength":40},"country":{"type":["string","null"],"maxLength":80},"taxId":{"type":["string","null"],"maxLength":120},"paymentTermsId":{"type":["string","null"],"format":"uuid"},"creditLimit":{"type":["object","null"],"properties":{"amountCents":{"type":["integer","null"],"minimum":0,"maximum":2147483647},"currencyCode":{"type":"string","minLength":3,"maxLength":3}},"required":["amountCents"],"additionalProperties":false},"preferredUnitOfMeasure":{"type":"string","enum":["NoPreference","Metric","Imperial"]},"costLedgerAccountId":{"type":["string","null"],"format":"uuid"},"supplierRepresentativeId":{"type":["string","null"],"format":"uuid"},"primaryShipFromAddress":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":160},"externalId":{"type":["string","null"],"maxLength":120},"street1":{"type":["string","null"],"maxLength":240},"street2":{"type":["string","null"],"maxLength":240},"city":{"type":["string","null"],"maxLength":120},"state":{"type":["string","null"],"maxLength":80},"zip":{"type":["string","null"],"maxLength":40},"country":{"type":["string","null"],"maxLength":80},"email":{"type":["string","null"],"maxLength":240},"phone":{"type":["string","null"],"maxLength":80},"defaultSupplierShippingInstructions":{"type":["string","null"],"maxLength":2000}},"additionalProperties":false}},"additionalProperties":false},"PublicAPICreateSupplierShipFromLocationRequest":{"type":"object","properties":{"street1":{"type":["string","null"],"maxLength":240},"street2":{"type":["string","null"],"maxLength":240},"city":{"type":["string","null"],"maxLength":120},"state":{"type":["string","null"],"maxLength":80},"zip":{"type":["string","null"],"maxLength":40},"country":{"type":["string","null"],"maxLength":80},"name":{"type":"string","minLength":1,"maxLength":160},"externalId":{"type":["string","null"],"maxLength":120},"email":{"type":["string","null"],"maxLength":240},"phone":{"type":["string","null"],"maxLength":80},"defaultSupplierShippingInstructions":{"type":["string","null"],"maxLength":2000},"duplicateResolution":{"type":"string","enum":["create_distinct"]}},"required":["name"],"additionalProperties":false},"PublicAPIUpdateSupplierShipFromLocationRequest":{"type":"object","properties":{"street1":{"type":["string","null"],"maxLength":240},"street2":{"type":["string","null"],"maxLength":240},"city":{"type":["string","null"],"maxLength":120},"state":{"type":["string","null"],"maxLength":80},"zip":{"type":["string","null"],"maxLength":40},"country":{"type":["string","null"],"maxLength":80},"name":{"type":"string","minLength":1,"maxLength":160},"externalId":{"type":["string","null"],"maxLength":120},"email":{"type":["string","null"],"maxLength":240},"phone":{"type":["string","null"],"maxLength":80},"defaultSupplierShippingInstructions":{"type":["string","null"],"maxLength":2000}},"additionalProperties":false},"PublicAPICreateProductRequest":{"type":"object","properties":{"code":{"type":"string","minLength":1,"maxLength":120},"externalId":{"type":["string","null"],"maxLength":120},"productFamilyId":{"type":"string","format":"uuid"},"packagingId":{"type":"string","format":"uuid"},"supplierId":{"type":["string","null"],"format":"uuid"},"packagingType":{"type":"string","enum":["FIXED","VARIABLE"],"default":"FIXED"},"supplierType":{"type":"string","enum":["FIXED","VARIABLE"],"default":"VARIABLE"},"qty":{"anyOf":[{"type":"string"},{"type":"number"}]},"casNumber":{"type":["string","null"],"maxLength":80},"ghsSignalWord":{"type":["string","null"],"enum":["DANGER","WARNING"]},"freightClass":{"type":["string","null"],"maxLength":40},"nmfcCode":{"type":["string","null"],"maxLength":20},"netUnitWeightLbs":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"null"}]},"unNumber":{"type":["string","null"],"maxLength":20},"properShippingName":{"type":["string","null"],"maxLength":240},"hazardClass":{"type":"array","items":{"type":"string","minLength":1,"maxLength":40},"default":[]},"packingGroup":{"type":["string","null"],"maxLength":20},"specialDesignation":{"type":["string","null"],"maxLength":120},"packagesPerPallet":{"type":["integer","null"],"minimum":0},"hazardSymbols":{"type":"array","items":{"type":"string","minLength":1,"maxLength":80},"default":[]},"attributeAssignments":{"type":"array","items":{"type":"object","properties":{"attributeId":{"type":"string","format":"uuid"},"optionIds":{"type":"array","items":{"type":"string","format":"uuid"}},"textValue":{"type":["string","null"],"maxLength":500},"booleanValue":{"type":["boolean","null"]}},"required":["attributeId"],"additionalProperties":false},"default":[]}},"required":["code","productFamilyId","packagingId","qty"],"additionalProperties":false},"PublicAPIUpdateProductRequest":{"type":"object","properties":{"code":{"type":"string","minLength":1,"maxLength":120},"externalId":{"type":["string","null"],"maxLength":120},"productFamilyId":{"type":"string","format":"uuid"},"packagingId":{"type":"string","format":"uuid"},"supplierId":{"type":["string","null"],"format":"uuid"},"packagingType":{"type":"string","enum":["FIXED","VARIABLE"]},"supplierType":{"type":"string","enum":["FIXED","VARIABLE"]},"qty":{"anyOf":[{"type":"string"},{"type":"number"}]},"casNumber":{"type":["string","null"],"maxLength":80},"ghsSignalWord":{"type":["string","null"],"enum":["DANGER","WARNING"]},"freightClass":{"type":["string","null"],"maxLength":40},"nmfcCode":{"type":["string","null"],"maxLength":20},"netUnitWeightLbs":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"null"}]},"unNumber":{"type":["string","null"],"maxLength":20},"properShippingName":{"type":["string","null"],"maxLength":240},"hazardClass":{"type":"array","items":{"type":"string","minLength":1,"maxLength":40}},"packingGroup":{"type":["string","null"],"maxLength":20},"specialDesignation":{"type":["string","null"],"maxLength":120},"packagesPerPallet":{"type":["integer","null"],"minimum":0},"hazardSymbols":{"type":"array","items":{"type":"string","minLength":1,"maxLength":80}},"attributeAssignments":{"type":"array","items":{"type":"object","properties":{"attributeId":{"type":"string","format":"uuid"},"optionIds":{"type":"array","items":{"type":"string","format":"uuid"}},"textValue":{"type":["string","null"],"maxLength":500},"booleanValue":{"type":["boolean","null"]}},"required":["attributeId"],"additionalProperties":false}}},"additionalProperties":false},"PublicAPICreateDocumentRequest":{"type":"object","properties":{"fileName":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[^\\u0000-\\u001F\\u007F]*$"},"url":{"type":"string","minLength":1,"maxLength":2048}},"required":["fileName","url"],"additionalProperties":false},"PublicAPICreateProductFamilyRequest":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":240},"externalId":{"type":["string","null"],"maxLength":120},"casNumber":{"type":["string","null"],"maxLength":80},"molecularFormula":{"type":["string","null"],"maxLength":120},"unNumbers":{"type":"array","items":{"type":"string","minLength":1,"maxLength":20},"default":[]},"ghsSignalWord":{"type":["string","null"],"enum":["DANGER","WARNING"]},"hazardSymbols":{"type":"array","items":{"type":"string","minLength":1,"maxLength":80},"default":[]}},"required":["name"],"additionalProperties":false},"PublicAPIUpdateProductFamilyRequest":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":240},"externalId":{"type":["string","null"],"maxLength":120},"casNumber":{"type":["string","null"],"maxLength":80},"molecularFormula":{"type":["string","null"],"maxLength":120},"unNumbers":{"type":"array","items":{"type":"string","minLength":1,"maxLength":20}},"ghsSignalWord":{"type":["string","null"],"enum":["DANGER","WARNING"]},"hazardSymbols":{"type":"array","items":{"type":"string","minLength":1,"maxLength":80}}},"additionalProperties":false},"PublicAPICostBookCreateRequest":{"anyOf":[{"type":"object","properties":{"productId":{"type":"string","format":"uuid"},"supplierId":{"type":"string","format":"uuid"},"expectedCurrentEntryId":{"type":["string","null"],"format":"uuid"},"effectiveFrom":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"effectiveTo":{"type":["string","null"],"pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"note":{"type":["string","null"],"maxLength":2000},"sourceRef":{"type":["string","null"],"maxLength":500},"terms":{"type":["string","null"],"maxLength":4000},"arrangementId":{"type":["string","null"],"format":"uuid"},"newArrangement":{"type":["object","null"],"properties":{"name":{"type":"string","minLength":1,"maxLength":160},"kind":{"type":"string","enum":["GENERAL","AT_PICKUP","AT_DESTINATION"]},"shipFromLocationId":{"type":["string","null"],"format":"uuid"},"destinationScope":{"type":["object","null"],"properties":{"countryCode":{"type":["string","null"],"minLength":2,"maxLength":2},"state":{"type":["string","null"],"maxLength":120},"city":{"type":["string","null"],"maxLength":120}},"additionalProperties":false}},"required":["name","kind"],"additionalProperties":false},"shipFromLocationId":{"type":["string","null"],"format":"uuid"},"incoterm":{"type":["string","null"],"enum":["EXW","FCA","FAS","FOB","CFR","CIF","CPT","CIP","DAP","DPU","DDP","None"]},"construction":{"type":"object","properties":{"type":{"type":"string","enum":["direct"]},"basis":{"type":"string","enum":["material","landed"]},"uom":{"type":"string","enum":["GALLON","LITER","POUND","KILOGRAM","EACH","METRIC_TON","SHORT_TON"]},"costPerBaseUomCents":{"type":"string"},"rates":{"type":"array","items":{"type":"object","properties":{"costPerBaseUomCents":{"type":"string"},"minimumQuantity":{"type":["string","null"]},"minimumBasis":{"type":["string","null"],"enum":["product_uom","package"]},"minimumProductPackagingId":{"type":["string","null"],"format":"uuid"}},"required":["costPerBaseUomCents"],"additionalProperties":false},"minItems":1,"maxItems":50}},"required":["type","basis","uom"],"additionalProperties":false}},"required":["productId","supplierId","expectedCurrentEntryId","effectiveFrom","construction"],"additionalProperties":false},{"type":"object","properties":{"productId":{"type":"string","format":"uuid"},"supplierId":{"type":"string","format":"uuid"},"expectedCurrentEntryId":{"type":["string","null"],"format":"uuid"},"effectiveFrom":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"effectiveTo":{"type":["string","null"],"pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"note":{"type":["string","null"],"maxLength":2000},"sourceRef":{"type":["string","null"],"maxLength":500},"terms":{"type":["string","null"],"maxLength":4000},"arrangementId":{"type":["string","null"],"format":"uuid"},"newArrangement":{"type":["object","null"],"properties":{"name":{"type":"string","minLength":1,"maxLength":160},"kind":{"type":"string","enum":["GENERAL","AT_PICKUP","AT_DESTINATION"]},"shipFromLocationId":{"type":["string","null"],"format":"uuid"},"destinationScope":{"type":["object","null"],"properties":{"countryCode":{"type":["string","null"],"minLength":2,"maxLength":2},"state":{"type":["string","null"],"maxLength":120},"city":{"type":["string","null"],"maxLength":120}},"additionalProperties":false}},"required":["name","kind"],"additionalProperties":false},"shipFromLocationId":{"type":["string","null"],"format":"uuid"},"incoterm":{"type":"null"},"construction":{"type":"object","properties":{"type":{"type":"string","enum":["constructed"]},"startingCost":{"type":"object","properties":{"source":{"type":"string","enum":["entered"]},"basis":{"type":"string","enum":["material","landed"]},"uom":{"type":"string","enum":["GALLON","LITER","POUND","KILOGRAM","EACH","METRIC_TON","SHORT_TON"]},"costPerBaseUomCents":{"type":"string"}},"required":["source","basis","uom","costPerBaseUomCents"],"additionalProperties":false},"additionalCosts":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"class":{"type":"string","enum":["FREIGHT","PACKAGING","DUTY","STORAGE","PROCESSING","HANDLING","TAX","OTHER"]},"method":{"type":"string","enum":["percent_of_starting_cost"]},"value":{"type":"string","pattern":"^(?:100(?:\\.0{1,16})?|(?:[1-9]\\d?)(?:\\.\\d{1,16})?|0\\.(?=\\d{1,16}$)(?=.*[1-9])\\d+)$"},"description":{"type":["string","null"],"maxLength":500}},"required":["class","method","value"],"additionalProperties":false},{"type":"object","properties":{"class":{"type":"string","enum":["FREIGHT","PACKAGING","DUTY","STORAGE","PROCESSING","HANDLING","TAX","OTHER"]},"method":{"type":"string","enum":["cents_per_base_uom","cents_per_package"]},"value":{"type":"string"},"description":{"type":["string","null"],"maxLength":500}},"required":["class","method","value"],"additionalProperties":false}]},"minItems":1,"maxItems":50}},"required":["type","startingCost","additionalCosts"],"additionalProperties":false}},"required":["productId","supplierId","expectedCurrentEntryId","effectiveFrom","construction"],"additionalProperties":false},{"type":"object","properties":{"productId":{"type":"string","format":"uuid"},"supplierId":{"type":"string","format":"uuid"},"expectedCurrentEntryId":{"type":["string","null"],"format":"uuid"},"effectiveFrom":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"effectiveTo":{"type":["string","null"],"pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"note":{"type":["string","null"],"maxLength":2000},"sourceRef":{"type":["string","null"],"maxLength":500},"terms":{"type":["string","null"],"maxLength":4000},"arrangementId":{"type":["string","null"],"format":"uuid"},"newArrangement":{"type":["object","null"],"properties":{"name":{"type":"string","minLength":1,"maxLength":160},"kind":{"type":"string","enum":["GENERAL","AT_PICKUP","AT_DESTINATION"]},"shipFromLocationId":{"type":["string","null"],"format":"uuid"},"destinationScope":{"type":["object","null"],"properties":{"countryCode":{"type":["string","null"],"minLength":2,"maxLength":2},"state":{"type":["string","null"],"maxLength":120},"city":{"type":["string","null"],"maxLength":120}},"additionalProperties":false}},"required":["name","kind"],"additionalProperties":false},"shipFromLocationId":{"type":["string","null"],"format":"uuid"},"incoterm":{"type":"null"},"construction":{"type":"object","properties":{"type":{"type":"string","enum":["constructed"]},"startingCost":{"type":"object","properties":{"source":{"type":"string","enum":["cost_book_entry"]},"productId":{"type":"string","format":"uuid"}},"required":["source","productId"],"additionalProperties":false},"additionalCosts":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"class":{"type":"string","enum":["FREIGHT","PACKAGING","DUTY","STORAGE","PROCESSING","HANDLING","TAX","OTHER"]},"method":{"type":"string","enum":["percent_of_starting_cost"]},"value":{"type":"string","pattern":"^(?:100(?:\\.0{1,16})?|(?:[1-9]\\d?)(?:\\.\\d{1,16})?|0\\.(?=\\d{1,16}$)(?=.*[1-9])\\d+)$"},"description":{"type":["string","null"],"maxLength":500}},"required":["class","method","value"],"additionalProperties":false},{"type":"object","properties":{"class":{"type":"string","enum":["FREIGHT","PACKAGING","DUTY","STORAGE","PROCESSING","HANDLING","TAX","OTHER"]},"method":{"type":"string","enum":["cents_per_base_uom","cents_per_package"]},"value":{"type":"string"},"description":{"type":["string","null"],"maxLength":500}},"required":["class","method","value"],"additionalProperties":false}]},"maxItems":50}},"required":["type","startingCost","additionalCosts"],"additionalProperties":false}},"required":["productId","supplierId","expectedCurrentEntryId","effectiveFrom","construction"],"additionalProperties":false}]},"PublicAPICostBookQuery":{"type":"object","properties":{"createdById":{"type":"string"},"createdFrom":{"type":"string"},"createdTo":{"type":"string"},"view":{"type":"string"},"asOf":{"type":"string"},"productId":{"type":"string"},"supplierId":{"type":"string"},"shipFromLocationId":{"type":"string"},"entryType":{"type":"string"},"effectiveState":{"type":"string"},"versionState":{"type":"string"},"claimRole":{"type":"string"},"disposition":{"type":"string"},"completeness":{"type":"string"},"includeArchivedEntities":{"type":"string","enum":["true","false"]},"limit":{"type":"string","pattern":"^\\d+$"},"cursor":{"type":"string"}},"additionalProperties":false},"PublicAPICurrentCostSourceRequest":{"type":"object","properties":{"supplierId":{"type":["string","null"],"format":"uuid"},"shipFromLocationId":{"type":["string","null"],"format":"uuid"},"expectedCurrentSupplierId":{"type":["string","null"],"format":"uuid"},"expectedCurrentShipFromLocationId":{"type":["string","null"],"format":"uuid"}},"required":["supplierId","expectedCurrentSupplierId"],"additionalProperties":false},"PublicAPIProductCostContextQuery":{"type":"object","properties":{"supplierId":{"type":"string","format":"uuid"},"asOf":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"}},"additionalProperties":false},"PublicAPIListChildRecordsQuery":{"type":"object","properties":{"limit":{"type":"string"},"cursor":{"type":"string","maxLength":2048}},"additionalProperties":false},"PublicAPISearchQuery":{"type":"object","properties":{"q":{"type":"string","minLength":2,"maxLength":120},"types":{"type":"string"},"limit":{"type":"string"}},"required":["q"],"additionalProperties":false}},"parameters":{}},"paths":{"/api/v1/products/{id}/archive":{"post":{"operationId":"archiveProduct","summary":"Archive a product","description":"Archives or restores one product. Preview with dryRun=true to review readiness and retrieve the current updatedAt value, then send it in If-Match to apply the action. The acting person must have current Product archive permission. The request may omit a body or use an empty JSON object. Product safeguards are reported as clear categories and counts.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"products:write","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","enum":["true"]},"required":false,"name":"dryRun","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check."},"required":false,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check.","name":"If-Match","in":"header"}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false}}}},"responses":{"200":{"description":"Lifecycle receipt or dry-run readiness.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["lifecycle_receipt"]},"resource":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","customer_contact","supplier_contact","customer_address","supplier_ship_from_location","representative","product","warehouse","shipping_option"]},"kind":{"type":"string","enum":["salesperson","customer_service","supplier"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},"action":{"type":"string","enum":["archive","unarchive"]},"archived":{"type":"boolean"},"changed":{"type":"boolean"},"updatedAt":{"type":"string","format":"date-time"},"requestId":{"type":"string"},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false}},"required":["type","resource","action","archived","changed","updatedAt","requestId","verification"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["write_readiness"]},"operation":{"type":"string","enum":["warehouses.create","warehouses.update","warehouses.archive","warehouses.unarchive","shipping_options.create","shipping_options.update","shipping_options.archive","shipping_options.unarchive","reorder_points.create","tags.create","tags.update","tag_assignments.create","tag_assignments.delete","notes.create","notes.update","opportunities.create","opportunities.update","opportunities.close","opportunities.meta-upsert","contacts.create","contacts.update","customers.create","customers.update","customer_locations.create","customer_locations.update","customer_addresses.create","customer_addresses.update","suppliers.create","suppliers.update","supplier_ship_from_locations.create","supplier_ship_from_locations.update","products.create","products.update","products.archive","products.unarchive","product_packaging.create","products.suppliers.create","products.suppliers.delete","products.aliases.create","products.aliases.update","products.aliases.delete","product_families.aliases.create","product_families.aliases.update","product_families.aliases.delete","products.customer_part_numbers.create","products.customer_part_numbers.update","products.customer_part_numbers.delete","product_sds.update","product_documents.create","customer_documents.create","supplier_documents.create","purchase_order_documents.create","product_families.create","product_families.update","cost_book_entries.create","current_cost_sources.put","customers.archive","customers.unarchive","suppliers.archive","suppliers.unarchive","contacts.archive","contacts.unarchive","customer_addresses.archive","customer_addresses.unarchive","supplier_ship_from_locations.archive","supplier_ship_from_locations.unarchive","representatives.create","representatives.update","representatives.archive","representatives.unarchive","payment_terms.create","payment_terms.update","ledger_accounts.create","ledger_accounts.update"]},"status":{"type":"string","enum":["ready","blocked"]},"wouldWrite":{"type":"boolean","enum":[false]},"submit":{"type":"object","properties":{"method":{"type":"string","enum":["POST","PATCH","PUT","DELETE"]},"path":{"type":"string"},"query":{"type":"object","properties":{},"additionalProperties":false}},"required":["method","path","query"],"additionalProperties":false},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false},"checks":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["not_direct_ship","address_role_required","address_role_valid","already_assigned","already_exists","active_duplicate","ambiguous_external_id","ambiguous_natural_key","api_created","archived_target","archived_record","archive_blocked","account_type_locked","duplicate_candidate_found","duplicate_candidate_overflow","duplicate_check_clear","duplicate_check_not_needed","duplicate_contact","duplicate_customer","duplicate_customer_address","duplicate_customer_location","duplicate_note","duplicate_resolution_applied","duplicate_supplier","duplicate_supplier_ship_from_location","document_url_org_scoped","document_url_valid","upload_verified","sds_converged","idempotency_available","idempotency_key_required","idempotency_key_reused","idempotency_replay","idempotency_target_missing","income_statement_type_invalid","hard_identity_clear","nested_external_id_clear","commercial_references_valid","credit_denomination_mismatch","customer_service_representative_reference_active","ledger_account_reference_valid","payment_terms_reference_exists","sales_person_reference_active","supplier_representative_reference_active","duplicate_reference_identity","external_id_conflict","if_match_current","base_uom_transition_allowed","base_uom_transition_blocked","attribute_assignments_valid","attribute_assignments_invalid","selected_supplier_link","linked_records_available","natural_key_conflict","not_api_created","no_downstream_mutation","order_sensitive_update_allowed","order_sensitive_update_blocked","parent_available","cost_book_entry_blocked","cost_book_entry_valid","cost_book_reference_not_visible","unsupported_cost_book_uom","cost_uom_conversion_unavailable","cost_book_base_unavailable","cost_book_base_ambiguous","cost_ship_from_location_not_visible","cost_package_quantity_invalid","cost_component_invalid","cost_date_window_invalid","cost_date_overlap","cost_amount_overflow","cost_book_conflict","product_family_reference_active","product_packaging_reference_active","primary_child_available","primary_change_unsupported","reference_visibility_blocked","scope_authorized","stale_record","stale_cost_book_entry","supplier_reference_active","tag_applicable","tag_available","tag_exists","tag_found","tag_not_applicable","tag_not_found","type_immutable","type_known","type_required","target_active","target_available","target_not_found_or_not_visible","targets_visible","unsupported_linked_record","unsupported_profile_shape","variable_qty_valid","validation_failed","value_nonempty"]},"status":{"type":"string","enum":["passed","blocked"]},"message":{"type":"string"},"param":{"type":"string"}},"required":["code","status","message"],"additionalProperties":false}},"duplicateCandidates":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact","customer","supplier","customer_location","customer_address","supplier_ship_from_location","product","product_family","document"]},"readable":{"type":"boolean"},"version":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","product","purchase_order"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"matchReasons":{"type":"array","items":{"type":"string","enum":["name","email","externalId","address","code","product","url"]}},"readbackPath":{"type":"string"}},"required":["type","readable","matchReasons"],"additionalProperties":false}},"idempotency":{"type":"object","properties":{"required":{"type":"boolean"},"keyProvided":{"type":"boolean"},"wouldReplay":{"type":"boolean"}},"required":["required","keyProvided","wouldReplay"],"additionalProperties":false},"wouldChange":{"type":"object","properties":{"fieldNames":{"type":"array","items":{"type":"string"}},"values":{"type":"object","additionalProperties":{}}},"required":["fieldNames","values"],"additionalProperties":false},"impactAnalysis":{"type":"object","additionalProperties":{}},"requestId":{"type":"string"}},"required":["type","operation","status","wouldWrite","submit","verification","checks","duplicateCandidates","requestId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}]}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested parent or record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"409":{"description":"The write conflicted with an existing record, idempotency payload, or stale If-Match value.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/products/{id}/unarchive":{"post":{"operationId":"unarchiveProduct","summary":"Restore a product","description":"Archives or restores one product. Preview with dryRun=true to review readiness and retrieve the current updatedAt value, then send it in If-Match to apply the action. The acting person must have current Product archive permission. The request may omit a body or use an empty JSON object. Product safeguards are reported as clear categories and counts.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"products:write","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","enum":["true"]},"required":false,"name":"dryRun","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check."},"required":false,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check.","name":"If-Match","in":"header"}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false}}}},"responses":{"200":{"description":"Lifecycle receipt or dry-run readiness.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["lifecycle_receipt"]},"resource":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","customer_contact","supplier_contact","customer_address","supplier_ship_from_location","representative","product","warehouse","shipping_option"]},"kind":{"type":"string","enum":["salesperson","customer_service","supplier"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},"action":{"type":"string","enum":["archive","unarchive"]},"archived":{"type":"boolean"},"changed":{"type":"boolean"},"updatedAt":{"type":"string","format":"date-time"},"requestId":{"type":"string"},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false}},"required":["type","resource","action","archived","changed","updatedAt","requestId","verification"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["write_readiness"]},"operation":{"type":"string","enum":["warehouses.create","warehouses.update","warehouses.archive","warehouses.unarchive","shipping_options.create","shipping_options.update","shipping_options.archive","shipping_options.unarchive","reorder_points.create","tags.create","tags.update","tag_assignments.create","tag_assignments.delete","notes.create","notes.update","opportunities.create","opportunities.update","opportunities.close","opportunities.meta-upsert","contacts.create","contacts.update","customers.create","customers.update","customer_locations.create","customer_locations.update","customer_addresses.create","customer_addresses.update","suppliers.create","suppliers.update","supplier_ship_from_locations.create","supplier_ship_from_locations.update","products.create","products.update","products.archive","products.unarchive","product_packaging.create","products.suppliers.create","products.suppliers.delete","products.aliases.create","products.aliases.update","products.aliases.delete","product_families.aliases.create","product_families.aliases.update","product_families.aliases.delete","products.customer_part_numbers.create","products.customer_part_numbers.update","products.customer_part_numbers.delete","product_sds.update","product_documents.create","customer_documents.create","supplier_documents.create","purchase_order_documents.create","product_families.create","product_families.update","cost_book_entries.create","current_cost_sources.put","customers.archive","customers.unarchive","suppliers.archive","suppliers.unarchive","contacts.archive","contacts.unarchive","customer_addresses.archive","customer_addresses.unarchive","supplier_ship_from_locations.archive","supplier_ship_from_locations.unarchive","representatives.create","representatives.update","representatives.archive","representatives.unarchive","payment_terms.create","payment_terms.update","ledger_accounts.create","ledger_accounts.update"]},"status":{"type":"string","enum":["ready","blocked"]},"wouldWrite":{"type":"boolean","enum":[false]},"submit":{"type":"object","properties":{"method":{"type":"string","enum":["POST","PATCH","PUT","DELETE"]},"path":{"type":"string"},"query":{"type":"object","properties":{},"additionalProperties":false}},"required":["method","path","query"],"additionalProperties":false},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false},"checks":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["not_direct_ship","address_role_required","address_role_valid","already_assigned","already_exists","active_duplicate","ambiguous_external_id","ambiguous_natural_key","api_created","archived_target","archived_record","archive_blocked","account_type_locked","duplicate_candidate_found","duplicate_candidate_overflow","duplicate_check_clear","duplicate_check_not_needed","duplicate_contact","duplicate_customer","duplicate_customer_address","duplicate_customer_location","duplicate_note","duplicate_resolution_applied","duplicate_supplier","duplicate_supplier_ship_from_location","document_url_org_scoped","document_url_valid","upload_verified","sds_converged","idempotency_available","idempotency_key_required","idempotency_key_reused","idempotency_replay","idempotency_target_missing","income_statement_type_invalid","hard_identity_clear","nested_external_id_clear","commercial_references_valid","credit_denomination_mismatch","customer_service_representative_reference_active","ledger_account_reference_valid","payment_terms_reference_exists","sales_person_reference_active","supplier_representative_reference_active","duplicate_reference_identity","external_id_conflict","if_match_current","base_uom_transition_allowed","base_uom_transition_blocked","attribute_assignments_valid","attribute_assignments_invalid","selected_supplier_link","linked_records_available","natural_key_conflict","not_api_created","no_downstream_mutation","order_sensitive_update_allowed","order_sensitive_update_blocked","parent_available","cost_book_entry_blocked","cost_book_entry_valid","cost_book_reference_not_visible","unsupported_cost_book_uom","cost_uom_conversion_unavailable","cost_book_base_unavailable","cost_book_base_ambiguous","cost_ship_from_location_not_visible","cost_package_quantity_invalid","cost_component_invalid","cost_date_window_invalid","cost_date_overlap","cost_amount_overflow","cost_book_conflict","product_family_reference_active","product_packaging_reference_active","primary_child_available","primary_change_unsupported","reference_visibility_blocked","scope_authorized","stale_record","stale_cost_book_entry","supplier_reference_active","tag_applicable","tag_available","tag_exists","tag_found","tag_not_applicable","tag_not_found","type_immutable","type_known","type_required","target_active","target_available","target_not_found_or_not_visible","targets_visible","unsupported_linked_record","unsupported_profile_shape","variable_qty_valid","validation_failed","value_nonempty"]},"status":{"type":"string","enum":["passed","blocked"]},"message":{"type":"string"},"param":{"type":"string"}},"required":["code","status","message"],"additionalProperties":false}},"duplicateCandidates":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact","customer","supplier","customer_location","customer_address","supplier_ship_from_location","product","product_family","document"]},"readable":{"type":"boolean"},"version":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","product","purchase_order"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"matchReasons":{"type":"array","items":{"type":"string","enum":["name","email","externalId","address","code","product","url"]}},"readbackPath":{"type":"string"}},"required":["type","readable","matchReasons"],"additionalProperties":false}},"idempotency":{"type":"object","properties":{"required":{"type":"boolean"},"keyProvided":{"type":"boolean"},"wouldReplay":{"type":"boolean"}},"required":["required","keyProvided","wouldReplay"],"additionalProperties":false},"wouldChange":{"type":"object","properties":{"fieldNames":{"type":"array","items":{"type":"string"}},"values":{"type":"object","additionalProperties":{}}},"required":["fieldNames","values"],"additionalProperties":false},"impactAnalysis":{"type":"object","additionalProperties":{}},"requestId":{"type":"string"}},"required":["type","operation","status","wouldWrite","submit","verification","checks","duplicateCandidates","requestId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}]}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested parent or record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"409":{"description":"The write conflicted with an existing record, idempotency payload, or stale If-Match value.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/customers/{id}/archive":{"post":{"operationId":"archiveCustomer","summary":"Archive a customer","description":"Archives or restores one customer. Preview with dryRun=true to review readiness and retrieve the current updatedAt value, then send it in If-Match to apply the action. The acting person must have current customer archive permission. The request may omit a body or use an empty JSON object. Customer safeguards are reported as clear categories and counts.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"customers:write","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","enum":["true"]},"required":false,"name":"dryRun","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check."},"required":false,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check.","name":"If-Match","in":"header"}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false}}}},"responses":{"200":{"description":"Lifecycle receipt or dry-run readiness.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["lifecycle_receipt"]},"resource":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","customer_contact","supplier_contact","customer_address","supplier_ship_from_location","representative","product","warehouse","shipping_option"]},"kind":{"type":"string","enum":["salesperson","customer_service","supplier"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},"action":{"type":"string","enum":["archive","unarchive"]},"archived":{"type":"boolean"},"changed":{"type":"boolean"},"updatedAt":{"type":"string","format":"date-time"},"requestId":{"type":"string"},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false}},"required":["type","resource","action","archived","changed","updatedAt","requestId","verification"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["write_readiness"]},"operation":{"type":"string","enum":["warehouses.create","warehouses.update","warehouses.archive","warehouses.unarchive","shipping_options.create","shipping_options.update","shipping_options.archive","shipping_options.unarchive","reorder_points.create","tags.create","tags.update","tag_assignments.create","tag_assignments.delete","notes.create","notes.update","opportunities.create","opportunities.update","opportunities.close","opportunities.meta-upsert","contacts.create","contacts.update","customers.create","customers.update","customer_locations.create","customer_locations.update","customer_addresses.create","customer_addresses.update","suppliers.create","suppliers.update","supplier_ship_from_locations.create","supplier_ship_from_locations.update","products.create","products.update","products.archive","products.unarchive","product_packaging.create","products.suppliers.create","products.suppliers.delete","products.aliases.create","products.aliases.update","products.aliases.delete","product_families.aliases.create","product_families.aliases.update","product_families.aliases.delete","products.customer_part_numbers.create","products.customer_part_numbers.update","products.customer_part_numbers.delete","product_sds.update","product_documents.create","customer_documents.create","supplier_documents.create","purchase_order_documents.create","product_families.create","product_families.update","cost_book_entries.create","current_cost_sources.put","customers.archive","customers.unarchive","suppliers.archive","suppliers.unarchive","contacts.archive","contacts.unarchive","customer_addresses.archive","customer_addresses.unarchive","supplier_ship_from_locations.archive","supplier_ship_from_locations.unarchive","representatives.create","representatives.update","representatives.archive","representatives.unarchive","payment_terms.create","payment_terms.update","ledger_accounts.create","ledger_accounts.update"]},"status":{"type":"string","enum":["ready","blocked"]},"wouldWrite":{"type":"boolean","enum":[false]},"submit":{"type":"object","properties":{"method":{"type":"string","enum":["POST","PATCH","PUT","DELETE"]},"path":{"type":"string"},"query":{"type":"object","properties":{},"additionalProperties":false}},"required":["method","path","query"],"additionalProperties":false},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false},"checks":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["not_direct_ship","address_role_required","address_role_valid","already_assigned","already_exists","active_duplicate","ambiguous_external_id","ambiguous_natural_key","api_created","archived_target","archived_record","archive_blocked","account_type_locked","duplicate_candidate_found","duplicate_candidate_overflow","duplicate_check_clear","duplicate_check_not_needed","duplicate_contact","duplicate_customer","duplicate_customer_address","duplicate_customer_location","duplicate_note","duplicate_resolution_applied","duplicate_supplier","duplicate_supplier_ship_from_location","document_url_org_scoped","document_url_valid","upload_verified","sds_converged","idempotency_available","idempotency_key_required","idempotency_key_reused","idempotency_replay","idempotency_target_missing","income_statement_type_invalid","hard_identity_clear","nested_external_id_clear","commercial_references_valid","credit_denomination_mismatch","customer_service_representative_reference_active","ledger_account_reference_valid","payment_terms_reference_exists","sales_person_reference_active","supplier_representative_reference_active","duplicate_reference_identity","external_id_conflict","if_match_current","base_uom_transition_allowed","base_uom_transition_blocked","attribute_assignments_valid","attribute_assignments_invalid","selected_supplier_link","linked_records_available","natural_key_conflict","not_api_created","no_downstream_mutation","order_sensitive_update_allowed","order_sensitive_update_blocked","parent_available","cost_book_entry_blocked","cost_book_entry_valid","cost_book_reference_not_visible","unsupported_cost_book_uom","cost_uom_conversion_unavailable","cost_book_base_unavailable","cost_book_base_ambiguous","cost_ship_from_location_not_visible","cost_package_quantity_invalid","cost_component_invalid","cost_date_window_invalid","cost_date_overlap","cost_amount_overflow","cost_book_conflict","product_family_reference_active","product_packaging_reference_active","primary_child_available","primary_change_unsupported","reference_visibility_blocked","scope_authorized","stale_record","stale_cost_book_entry","supplier_reference_active","tag_applicable","tag_available","tag_exists","tag_found","tag_not_applicable","tag_not_found","type_immutable","type_known","type_required","target_active","target_available","target_not_found_or_not_visible","targets_visible","unsupported_linked_record","unsupported_profile_shape","variable_qty_valid","validation_failed","value_nonempty"]},"status":{"type":"string","enum":["passed","blocked"]},"message":{"type":"string"},"param":{"type":"string"}},"required":["code","status","message"],"additionalProperties":false}},"duplicateCandidates":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact","customer","supplier","customer_location","customer_address","supplier_ship_from_location","product","product_family","document"]},"readable":{"type":"boolean"},"version":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","product","purchase_order"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"matchReasons":{"type":"array","items":{"type":"string","enum":["name","email","externalId","address","code","product","url"]}},"readbackPath":{"type":"string"}},"required":["type","readable","matchReasons"],"additionalProperties":false}},"idempotency":{"type":"object","properties":{"required":{"type":"boolean"},"keyProvided":{"type":"boolean"},"wouldReplay":{"type":"boolean"}},"required":["required","keyProvided","wouldReplay"],"additionalProperties":false},"wouldChange":{"type":"object","properties":{"fieldNames":{"type":"array","items":{"type":"string"}},"values":{"type":"object","additionalProperties":{}}},"required":["fieldNames","values"],"additionalProperties":false},"impactAnalysis":{"type":"object","additionalProperties":{}},"requestId":{"type":"string"}},"required":["type","operation","status","wouldWrite","submit","verification","checks","duplicateCandidates","requestId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}]}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested parent or record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"409":{"description":"The write conflicted with an existing record, idempotency payload, or stale If-Match value.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/customers/{id}/unarchive":{"post":{"operationId":"unarchiveCustomer","summary":"Restore a customer","description":"Archives or restores one customer. Preview with dryRun=true to review readiness and retrieve the current updatedAt value, then send it in If-Match to apply the action. The acting person must have current customer archive permission. The request may omit a body or use an empty JSON object. Customer safeguards are reported as clear categories and counts.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"customers:write","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","enum":["true"]},"required":false,"name":"dryRun","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check."},"required":false,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check.","name":"If-Match","in":"header"}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false}}}},"responses":{"200":{"description":"Lifecycle receipt or dry-run readiness.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["lifecycle_receipt"]},"resource":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","customer_contact","supplier_contact","customer_address","supplier_ship_from_location","representative","product","warehouse","shipping_option"]},"kind":{"type":"string","enum":["salesperson","customer_service","supplier"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},"action":{"type":"string","enum":["archive","unarchive"]},"archived":{"type":"boolean"},"changed":{"type":"boolean"},"updatedAt":{"type":"string","format":"date-time"},"requestId":{"type":"string"},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false}},"required":["type","resource","action","archived","changed","updatedAt","requestId","verification"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["write_readiness"]},"operation":{"type":"string","enum":["warehouses.create","warehouses.update","warehouses.archive","warehouses.unarchive","shipping_options.create","shipping_options.update","shipping_options.archive","shipping_options.unarchive","reorder_points.create","tags.create","tags.update","tag_assignments.create","tag_assignments.delete","notes.create","notes.update","opportunities.create","opportunities.update","opportunities.close","opportunities.meta-upsert","contacts.create","contacts.update","customers.create","customers.update","customer_locations.create","customer_locations.update","customer_addresses.create","customer_addresses.update","suppliers.create","suppliers.update","supplier_ship_from_locations.create","supplier_ship_from_locations.update","products.create","products.update","products.archive","products.unarchive","product_packaging.create","products.suppliers.create","products.suppliers.delete","products.aliases.create","products.aliases.update","products.aliases.delete","product_families.aliases.create","product_families.aliases.update","product_families.aliases.delete","products.customer_part_numbers.create","products.customer_part_numbers.update","products.customer_part_numbers.delete","product_sds.update","product_documents.create","customer_documents.create","supplier_documents.create","purchase_order_documents.create","product_families.create","product_families.update","cost_book_entries.create","current_cost_sources.put","customers.archive","customers.unarchive","suppliers.archive","suppliers.unarchive","contacts.archive","contacts.unarchive","customer_addresses.archive","customer_addresses.unarchive","supplier_ship_from_locations.archive","supplier_ship_from_locations.unarchive","representatives.create","representatives.update","representatives.archive","representatives.unarchive","payment_terms.create","payment_terms.update","ledger_accounts.create","ledger_accounts.update"]},"status":{"type":"string","enum":["ready","blocked"]},"wouldWrite":{"type":"boolean","enum":[false]},"submit":{"type":"object","properties":{"method":{"type":"string","enum":["POST","PATCH","PUT","DELETE"]},"path":{"type":"string"},"query":{"type":"object","properties":{},"additionalProperties":false}},"required":["method","path","query"],"additionalProperties":false},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false},"checks":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["not_direct_ship","address_role_required","address_role_valid","already_assigned","already_exists","active_duplicate","ambiguous_external_id","ambiguous_natural_key","api_created","archived_target","archived_record","archive_blocked","account_type_locked","duplicate_candidate_found","duplicate_candidate_overflow","duplicate_check_clear","duplicate_check_not_needed","duplicate_contact","duplicate_customer","duplicate_customer_address","duplicate_customer_location","duplicate_note","duplicate_resolution_applied","duplicate_supplier","duplicate_supplier_ship_from_location","document_url_org_scoped","document_url_valid","upload_verified","sds_converged","idempotency_available","idempotency_key_required","idempotency_key_reused","idempotency_replay","idempotency_target_missing","income_statement_type_invalid","hard_identity_clear","nested_external_id_clear","commercial_references_valid","credit_denomination_mismatch","customer_service_representative_reference_active","ledger_account_reference_valid","payment_terms_reference_exists","sales_person_reference_active","supplier_representative_reference_active","duplicate_reference_identity","external_id_conflict","if_match_current","base_uom_transition_allowed","base_uom_transition_blocked","attribute_assignments_valid","attribute_assignments_invalid","selected_supplier_link","linked_records_available","natural_key_conflict","not_api_created","no_downstream_mutation","order_sensitive_update_allowed","order_sensitive_update_blocked","parent_available","cost_book_entry_blocked","cost_book_entry_valid","cost_book_reference_not_visible","unsupported_cost_book_uom","cost_uom_conversion_unavailable","cost_book_base_unavailable","cost_book_base_ambiguous","cost_ship_from_location_not_visible","cost_package_quantity_invalid","cost_component_invalid","cost_date_window_invalid","cost_date_overlap","cost_amount_overflow","cost_book_conflict","product_family_reference_active","product_packaging_reference_active","primary_child_available","primary_change_unsupported","reference_visibility_blocked","scope_authorized","stale_record","stale_cost_book_entry","supplier_reference_active","tag_applicable","tag_available","tag_exists","tag_found","tag_not_applicable","tag_not_found","type_immutable","type_known","type_required","target_active","target_available","target_not_found_or_not_visible","targets_visible","unsupported_linked_record","unsupported_profile_shape","variable_qty_valid","validation_failed","value_nonempty"]},"status":{"type":"string","enum":["passed","blocked"]},"message":{"type":"string"},"param":{"type":"string"}},"required":["code","status","message"],"additionalProperties":false}},"duplicateCandidates":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact","customer","supplier","customer_location","customer_address","supplier_ship_from_location","product","product_family","document"]},"readable":{"type":"boolean"},"version":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","product","purchase_order"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"matchReasons":{"type":"array","items":{"type":"string","enum":["name","email","externalId","address","code","product","url"]}},"readbackPath":{"type":"string"}},"required":["type","readable","matchReasons"],"additionalProperties":false}},"idempotency":{"type":"object","properties":{"required":{"type":"boolean"},"keyProvided":{"type":"boolean"},"wouldReplay":{"type":"boolean"}},"required":["required","keyProvided","wouldReplay"],"additionalProperties":false},"wouldChange":{"type":"object","properties":{"fieldNames":{"type":"array","items":{"type":"string"}},"values":{"type":"object","additionalProperties":{}}},"required":["fieldNames","values"],"additionalProperties":false},"impactAnalysis":{"type":"object","additionalProperties":{}},"requestId":{"type":"string"}},"required":["type","operation","status","wouldWrite","submit","verification","checks","duplicateCandidates","requestId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}]}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested parent or record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"409":{"description":"The write conflicted with an existing record, idempotency payload, or stale If-Match value.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/suppliers/{id}/archive":{"post":{"operationId":"archiveSupplier","summary":"Archive a supplier","description":"Archives or restores one supplier. Preview with dryRun=true to review readiness and retrieve the current updatedAt value, then send it in If-Match to apply the action. The acting person must have current supplier archive permission. The request may omit a body or use an empty JSON object. Supplier safeguards are reported as clear categories and counts.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"suppliers:write","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","enum":["true"]},"required":false,"name":"dryRun","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check."},"required":false,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check.","name":"If-Match","in":"header"}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false}}}},"responses":{"200":{"description":"Lifecycle receipt or dry-run readiness.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["lifecycle_receipt"]},"resource":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","customer_contact","supplier_contact","customer_address","supplier_ship_from_location","representative","product","warehouse","shipping_option"]},"kind":{"type":"string","enum":["salesperson","customer_service","supplier"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},"action":{"type":"string","enum":["archive","unarchive"]},"archived":{"type":"boolean"},"changed":{"type":"boolean"},"updatedAt":{"type":"string","format":"date-time"},"requestId":{"type":"string"},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false}},"required":["type","resource","action","archived","changed","updatedAt","requestId","verification"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["write_readiness"]},"operation":{"type":"string","enum":["warehouses.create","warehouses.update","warehouses.archive","warehouses.unarchive","shipping_options.create","shipping_options.update","shipping_options.archive","shipping_options.unarchive","reorder_points.create","tags.create","tags.update","tag_assignments.create","tag_assignments.delete","notes.create","notes.update","opportunities.create","opportunities.update","opportunities.close","opportunities.meta-upsert","contacts.create","contacts.update","customers.create","customers.update","customer_locations.create","customer_locations.update","customer_addresses.create","customer_addresses.update","suppliers.create","suppliers.update","supplier_ship_from_locations.create","supplier_ship_from_locations.update","products.create","products.update","products.archive","products.unarchive","product_packaging.create","products.suppliers.create","products.suppliers.delete","products.aliases.create","products.aliases.update","products.aliases.delete","product_families.aliases.create","product_families.aliases.update","product_families.aliases.delete","products.customer_part_numbers.create","products.customer_part_numbers.update","products.customer_part_numbers.delete","product_sds.update","product_documents.create","customer_documents.create","supplier_documents.create","purchase_order_documents.create","product_families.create","product_families.update","cost_book_entries.create","current_cost_sources.put","customers.archive","customers.unarchive","suppliers.archive","suppliers.unarchive","contacts.archive","contacts.unarchive","customer_addresses.archive","customer_addresses.unarchive","supplier_ship_from_locations.archive","supplier_ship_from_locations.unarchive","representatives.create","representatives.update","representatives.archive","representatives.unarchive","payment_terms.create","payment_terms.update","ledger_accounts.create","ledger_accounts.update"]},"status":{"type":"string","enum":["ready","blocked"]},"wouldWrite":{"type":"boolean","enum":[false]},"submit":{"type":"object","properties":{"method":{"type":"string","enum":["POST","PATCH","PUT","DELETE"]},"path":{"type":"string"},"query":{"type":"object","properties":{},"additionalProperties":false}},"required":["method","path","query"],"additionalProperties":false},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false},"checks":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["not_direct_ship","address_role_required","address_role_valid","already_assigned","already_exists","active_duplicate","ambiguous_external_id","ambiguous_natural_key","api_created","archived_target","archived_record","archive_blocked","account_type_locked","duplicate_candidate_found","duplicate_candidate_overflow","duplicate_check_clear","duplicate_check_not_needed","duplicate_contact","duplicate_customer","duplicate_customer_address","duplicate_customer_location","duplicate_note","duplicate_resolution_applied","duplicate_supplier","duplicate_supplier_ship_from_location","document_url_org_scoped","document_url_valid","upload_verified","sds_converged","idempotency_available","idempotency_key_required","idempotency_key_reused","idempotency_replay","idempotency_target_missing","income_statement_type_invalid","hard_identity_clear","nested_external_id_clear","commercial_references_valid","credit_denomination_mismatch","customer_service_representative_reference_active","ledger_account_reference_valid","payment_terms_reference_exists","sales_person_reference_active","supplier_representative_reference_active","duplicate_reference_identity","external_id_conflict","if_match_current","base_uom_transition_allowed","base_uom_transition_blocked","attribute_assignments_valid","attribute_assignments_invalid","selected_supplier_link","linked_records_available","natural_key_conflict","not_api_created","no_downstream_mutation","order_sensitive_update_allowed","order_sensitive_update_blocked","parent_available","cost_book_entry_blocked","cost_book_entry_valid","cost_book_reference_not_visible","unsupported_cost_book_uom","cost_uom_conversion_unavailable","cost_book_base_unavailable","cost_book_base_ambiguous","cost_ship_from_location_not_visible","cost_package_quantity_invalid","cost_component_invalid","cost_date_window_invalid","cost_date_overlap","cost_amount_overflow","cost_book_conflict","product_family_reference_active","product_packaging_reference_active","primary_child_available","primary_change_unsupported","reference_visibility_blocked","scope_authorized","stale_record","stale_cost_book_entry","supplier_reference_active","tag_applicable","tag_available","tag_exists","tag_found","tag_not_applicable","tag_not_found","type_immutable","type_known","type_required","target_active","target_available","target_not_found_or_not_visible","targets_visible","unsupported_linked_record","unsupported_profile_shape","variable_qty_valid","validation_failed","value_nonempty"]},"status":{"type":"string","enum":["passed","blocked"]},"message":{"type":"string"},"param":{"type":"string"}},"required":["code","status","message"],"additionalProperties":false}},"duplicateCandidates":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact","customer","supplier","customer_location","customer_address","supplier_ship_from_location","product","product_family","document"]},"readable":{"type":"boolean"},"version":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","product","purchase_order"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"matchReasons":{"type":"array","items":{"type":"string","enum":["name","email","externalId","address","code","product","url"]}},"readbackPath":{"type":"string"}},"required":["type","readable","matchReasons"],"additionalProperties":false}},"idempotency":{"type":"object","properties":{"required":{"type":"boolean"},"keyProvided":{"type":"boolean"},"wouldReplay":{"type":"boolean"}},"required":["required","keyProvided","wouldReplay"],"additionalProperties":false},"wouldChange":{"type":"object","properties":{"fieldNames":{"type":"array","items":{"type":"string"}},"values":{"type":"object","additionalProperties":{}}},"required":["fieldNames","values"],"additionalProperties":false},"impactAnalysis":{"type":"object","additionalProperties":{}},"requestId":{"type":"string"}},"required":["type","operation","status","wouldWrite","submit","verification","checks","duplicateCandidates","requestId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}]}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested parent or record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"409":{"description":"The write conflicted with an existing record, idempotency payload, or stale If-Match value.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/suppliers/{id}/unarchive":{"post":{"operationId":"unarchiveSupplier","summary":"Restore a supplier","description":"Archives or restores one supplier. Preview with dryRun=true to review readiness and retrieve the current updatedAt value, then send it in If-Match to apply the action. The acting person must have current supplier archive permission. The request may omit a body or use an empty JSON object. Supplier safeguards are reported as clear categories and counts.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"suppliers:write","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","enum":["true"]},"required":false,"name":"dryRun","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check."},"required":false,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check.","name":"If-Match","in":"header"}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false}}}},"responses":{"200":{"description":"Lifecycle receipt or dry-run readiness.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["lifecycle_receipt"]},"resource":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","customer_contact","supplier_contact","customer_address","supplier_ship_from_location","representative","product","warehouse","shipping_option"]},"kind":{"type":"string","enum":["salesperson","customer_service","supplier"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},"action":{"type":"string","enum":["archive","unarchive"]},"archived":{"type":"boolean"},"changed":{"type":"boolean"},"updatedAt":{"type":"string","format":"date-time"},"requestId":{"type":"string"},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false}},"required":["type","resource","action","archived","changed","updatedAt","requestId","verification"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["write_readiness"]},"operation":{"type":"string","enum":["warehouses.create","warehouses.update","warehouses.archive","warehouses.unarchive","shipping_options.create","shipping_options.update","shipping_options.archive","shipping_options.unarchive","reorder_points.create","tags.create","tags.update","tag_assignments.create","tag_assignments.delete","notes.create","notes.update","opportunities.create","opportunities.update","opportunities.close","opportunities.meta-upsert","contacts.create","contacts.update","customers.create","customers.update","customer_locations.create","customer_locations.update","customer_addresses.create","customer_addresses.update","suppliers.create","suppliers.update","supplier_ship_from_locations.create","supplier_ship_from_locations.update","products.create","products.update","products.archive","products.unarchive","product_packaging.create","products.suppliers.create","products.suppliers.delete","products.aliases.create","products.aliases.update","products.aliases.delete","product_families.aliases.create","product_families.aliases.update","product_families.aliases.delete","products.customer_part_numbers.create","products.customer_part_numbers.update","products.customer_part_numbers.delete","product_sds.update","product_documents.create","customer_documents.create","supplier_documents.create","purchase_order_documents.create","product_families.create","product_families.update","cost_book_entries.create","current_cost_sources.put","customers.archive","customers.unarchive","suppliers.archive","suppliers.unarchive","contacts.archive","contacts.unarchive","customer_addresses.archive","customer_addresses.unarchive","supplier_ship_from_locations.archive","supplier_ship_from_locations.unarchive","representatives.create","representatives.update","representatives.archive","representatives.unarchive","payment_terms.create","payment_terms.update","ledger_accounts.create","ledger_accounts.update"]},"status":{"type":"string","enum":["ready","blocked"]},"wouldWrite":{"type":"boolean","enum":[false]},"submit":{"type":"object","properties":{"method":{"type":"string","enum":["POST","PATCH","PUT","DELETE"]},"path":{"type":"string"},"query":{"type":"object","properties":{},"additionalProperties":false}},"required":["method","path","query"],"additionalProperties":false},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false},"checks":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["not_direct_ship","address_role_required","address_role_valid","already_assigned","already_exists","active_duplicate","ambiguous_external_id","ambiguous_natural_key","api_created","archived_target","archived_record","archive_blocked","account_type_locked","duplicate_candidate_found","duplicate_candidate_overflow","duplicate_check_clear","duplicate_check_not_needed","duplicate_contact","duplicate_customer","duplicate_customer_address","duplicate_customer_location","duplicate_note","duplicate_resolution_applied","duplicate_supplier","duplicate_supplier_ship_from_location","document_url_org_scoped","document_url_valid","upload_verified","sds_converged","idempotency_available","idempotency_key_required","idempotency_key_reused","idempotency_replay","idempotency_target_missing","income_statement_type_invalid","hard_identity_clear","nested_external_id_clear","commercial_references_valid","credit_denomination_mismatch","customer_service_representative_reference_active","ledger_account_reference_valid","payment_terms_reference_exists","sales_person_reference_active","supplier_representative_reference_active","duplicate_reference_identity","external_id_conflict","if_match_current","base_uom_transition_allowed","base_uom_transition_blocked","attribute_assignments_valid","attribute_assignments_invalid","selected_supplier_link","linked_records_available","natural_key_conflict","not_api_created","no_downstream_mutation","order_sensitive_update_allowed","order_sensitive_update_blocked","parent_available","cost_book_entry_blocked","cost_book_entry_valid","cost_book_reference_not_visible","unsupported_cost_book_uom","cost_uom_conversion_unavailable","cost_book_base_unavailable","cost_book_base_ambiguous","cost_ship_from_location_not_visible","cost_package_quantity_invalid","cost_component_invalid","cost_date_window_invalid","cost_date_overlap","cost_amount_overflow","cost_book_conflict","product_family_reference_active","product_packaging_reference_active","primary_child_available","primary_change_unsupported","reference_visibility_blocked","scope_authorized","stale_record","stale_cost_book_entry","supplier_reference_active","tag_applicable","tag_available","tag_exists","tag_found","tag_not_applicable","tag_not_found","type_immutable","type_known","type_required","target_active","target_available","target_not_found_or_not_visible","targets_visible","unsupported_linked_record","unsupported_profile_shape","variable_qty_valid","validation_failed","value_nonempty"]},"status":{"type":"string","enum":["passed","blocked"]},"message":{"type":"string"},"param":{"type":"string"}},"required":["code","status","message"],"additionalProperties":false}},"duplicateCandidates":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact","customer","supplier","customer_location","customer_address","supplier_ship_from_location","product","product_family","document"]},"readable":{"type":"boolean"},"version":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","product","purchase_order"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"matchReasons":{"type":"array","items":{"type":"string","enum":["name","email","externalId","address","code","product","url"]}},"readbackPath":{"type":"string"}},"required":["type","readable","matchReasons"],"additionalProperties":false}},"idempotency":{"type":"object","properties":{"required":{"type":"boolean"},"keyProvided":{"type":"boolean"},"wouldReplay":{"type":"boolean"}},"required":["required","keyProvided","wouldReplay"],"additionalProperties":false},"wouldChange":{"type":"object","properties":{"fieldNames":{"type":"array","items":{"type":"string"}},"values":{"type":"object","additionalProperties":{}}},"required":["fieldNames","values"],"additionalProperties":false},"impactAnalysis":{"type":"object","additionalProperties":{}},"requestId":{"type":"string"}},"required":["type","operation","status","wouldWrite","submit","verification","checks","duplicateCandidates","requestId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}]}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested parent or record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"409":{"description":"The write conflicted with an existing record, idempotency payload, or stale If-Match value.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/contacts/{id}/archive":{"post":{"operationId":"archiveContact","summary":"Archive a customer or supplier contact","description":"Archives or restores one selected customer or supplier contact. Preview with dryRun=true to review readiness and retrieve the current updatedAt value, then send it in If-Match to apply the action. The acting person must have current archive permission for the contact's customer or supplier. The request may omit a body or use an empty JSON object.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"contacts:update","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","enum":["true"]},"required":false,"name":"dryRun","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check."},"required":false,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check.","name":"If-Match","in":"header"}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false}}}},"responses":{"200":{"description":"Lifecycle receipt or dry-run readiness.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["lifecycle_receipt"]},"resource":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","customer_contact","supplier_contact","customer_address","supplier_ship_from_location","representative","product","warehouse","shipping_option"]},"kind":{"type":"string","enum":["salesperson","customer_service","supplier"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},"action":{"type":"string","enum":["archive","unarchive"]},"archived":{"type":"boolean"},"changed":{"type":"boolean"},"updatedAt":{"type":"string","format":"date-time"},"requestId":{"type":"string"},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false}},"required":["type","resource","action","archived","changed","updatedAt","requestId","verification"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["write_readiness"]},"operation":{"type":"string","enum":["warehouses.create","warehouses.update","warehouses.archive","warehouses.unarchive","shipping_options.create","shipping_options.update","shipping_options.archive","shipping_options.unarchive","reorder_points.create","tags.create","tags.update","tag_assignments.create","tag_assignments.delete","notes.create","notes.update","opportunities.create","opportunities.update","opportunities.close","opportunities.meta-upsert","contacts.create","contacts.update","customers.create","customers.update","customer_locations.create","customer_locations.update","customer_addresses.create","customer_addresses.update","suppliers.create","suppliers.update","supplier_ship_from_locations.create","supplier_ship_from_locations.update","products.create","products.update","products.archive","products.unarchive","product_packaging.create","products.suppliers.create","products.suppliers.delete","products.aliases.create","products.aliases.update","products.aliases.delete","product_families.aliases.create","product_families.aliases.update","product_families.aliases.delete","products.customer_part_numbers.create","products.customer_part_numbers.update","products.customer_part_numbers.delete","product_sds.update","product_documents.create","customer_documents.create","supplier_documents.create","purchase_order_documents.create","product_families.create","product_families.update","cost_book_entries.create","current_cost_sources.put","customers.archive","customers.unarchive","suppliers.archive","suppliers.unarchive","contacts.archive","contacts.unarchive","customer_addresses.archive","customer_addresses.unarchive","supplier_ship_from_locations.archive","supplier_ship_from_locations.unarchive","representatives.create","representatives.update","representatives.archive","representatives.unarchive","payment_terms.create","payment_terms.update","ledger_accounts.create","ledger_accounts.update"]},"status":{"type":"string","enum":["ready","blocked"]},"wouldWrite":{"type":"boolean","enum":[false]},"submit":{"type":"object","properties":{"method":{"type":"string","enum":["POST","PATCH","PUT","DELETE"]},"path":{"type":"string"},"query":{"type":"object","properties":{},"additionalProperties":false}},"required":["method","path","query"],"additionalProperties":false},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false},"checks":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["not_direct_ship","address_role_required","address_role_valid","already_assigned","already_exists","active_duplicate","ambiguous_external_id","ambiguous_natural_key","api_created","archived_target","archived_record","archive_blocked","account_type_locked","duplicate_candidate_found","duplicate_candidate_overflow","duplicate_check_clear","duplicate_check_not_needed","duplicate_contact","duplicate_customer","duplicate_customer_address","duplicate_customer_location","duplicate_note","duplicate_resolution_applied","duplicate_supplier","duplicate_supplier_ship_from_location","document_url_org_scoped","document_url_valid","upload_verified","sds_converged","idempotency_available","idempotency_key_required","idempotency_key_reused","idempotency_replay","idempotency_target_missing","income_statement_type_invalid","hard_identity_clear","nested_external_id_clear","commercial_references_valid","credit_denomination_mismatch","customer_service_representative_reference_active","ledger_account_reference_valid","payment_terms_reference_exists","sales_person_reference_active","supplier_representative_reference_active","duplicate_reference_identity","external_id_conflict","if_match_current","base_uom_transition_allowed","base_uom_transition_blocked","attribute_assignments_valid","attribute_assignments_invalid","selected_supplier_link","linked_records_available","natural_key_conflict","not_api_created","no_downstream_mutation","order_sensitive_update_allowed","order_sensitive_update_blocked","parent_available","cost_book_entry_blocked","cost_book_entry_valid","cost_book_reference_not_visible","unsupported_cost_book_uom","cost_uom_conversion_unavailable","cost_book_base_unavailable","cost_book_base_ambiguous","cost_ship_from_location_not_visible","cost_package_quantity_invalid","cost_component_invalid","cost_date_window_invalid","cost_date_overlap","cost_amount_overflow","cost_book_conflict","product_family_reference_active","product_packaging_reference_active","primary_child_available","primary_change_unsupported","reference_visibility_blocked","scope_authorized","stale_record","stale_cost_book_entry","supplier_reference_active","tag_applicable","tag_available","tag_exists","tag_found","tag_not_applicable","tag_not_found","type_immutable","type_known","type_required","target_active","target_available","target_not_found_or_not_visible","targets_visible","unsupported_linked_record","unsupported_profile_shape","variable_qty_valid","validation_failed","value_nonempty"]},"status":{"type":"string","enum":["passed","blocked"]},"message":{"type":"string"},"param":{"type":"string"}},"required":["code","status","message"],"additionalProperties":false}},"duplicateCandidates":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact","customer","supplier","customer_location","customer_address","supplier_ship_from_location","product","product_family","document"]},"readable":{"type":"boolean"},"version":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","product","purchase_order"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"matchReasons":{"type":"array","items":{"type":"string","enum":["name","email","externalId","address","code","product","url"]}},"readbackPath":{"type":"string"}},"required":["type","readable","matchReasons"],"additionalProperties":false}},"idempotency":{"type":"object","properties":{"required":{"type":"boolean"},"keyProvided":{"type":"boolean"},"wouldReplay":{"type":"boolean"}},"required":["required","keyProvided","wouldReplay"],"additionalProperties":false},"wouldChange":{"type":"object","properties":{"fieldNames":{"type":"array","items":{"type":"string"}},"values":{"type":"object","additionalProperties":{}}},"required":["fieldNames","values"],"additionalProperties":false},"impactAnalysis":{"type":"object","additionalProperties":{}},"requestId":{"type":"string"}},"required":["type","operation","status","wouldWrite","submit","verification","checks","duplicateCandidates","requestId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}]}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested parent or record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"409":{"description":"The write conflicted with an existing record, idempotency payload, or stale If-Match value.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/contacts/{id}/unarchive":{"post":{"operationId":"unarchiveContact","summary":"Restore a customer or supplier contact","description":"Archives or restores one selected customer or supplier contact. Preview with dryRun=true to review readiness and retrieve the current updatedAt value, then send it in If-Match to apply the action. The acting person must have current archive permission for the contact's customer or supplier. The request may omit a body or use an empty JSON object.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"contacts:update","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","enum":["true"]},"required":false,"name":"dryRun","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check."},"required":false,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check.","name":"If-Match","in":"header"}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false}}}},"responses":{"200":{"description":"Lifecycle receipt or dry-run readiness.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["lifecycle_receipt"]},"resource":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","customer_contact","supplier_contact","customer_address","supplier_ship_from_location","representative","product","warehouse","shipping_option"]},"kind":{"type":"string","enum":["salesperson","customer_service","supplier"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},"action":{"type":"string","enum":["archive","unarchive"]},"archived":{"type":"boolean"},"changed":{"type":"boolean"},"updatedAt":{"type":"string","format":"date-time"},"requestId":{"type":"string"},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false}},"required":["type","resource","action","archived","changed","updatedAt","requestId","verification"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["write_readiness"]},"operation":{"type":"string","enum":["warehouses.create","warehouses.update","warehouses.archive","warehouses.unarchive","shipping_options.create","shipping_options.update","shipping_options.archive","shipping_options.unarchive","reorder_points.create","tags.create","tags.update","tag_assignments.create","tag_assignments.delete","notes.create","notes.update","opportunities.create","opportunities.update","opportunities.close","opportunities.meta-upsert","contacts.create","contacts.update","customers.create","customers.update","customer_locations.create","customer_locations.update","customer_addresses.create","customer_addresses.update","suppliers.create","suppliers.update","supplier_ship_from_locations.create","supplier_ship_from_locations.update","products.create","products.update","products.archive","products.unarchive","product_packaging.create","products.suppliers.create","products.suppliers.delete","products.aliases.create","products.aliases.update","products.aliases.delete","product_families.aliases.create","product_families.aliases.update","product_families.aliases.delete","products.customer_part_numbers.create","products.customer_part_numbers.update","products.customer_part_numbers.delete","product_sds.update","product_documents.create","customer_documents.create","supplier_documents.create","purchase_order_documents.create","product_families.create","product_families.update","cost_book_entries.create","current_cost_sources.put","customers.archive","customers.unarchive","suppliers.archive","suppliers.unarchive","contacts.archive","contacts.unarchive","customer_addresses.archive","customer_addresses.unarchive","supplier_ship_from_locations.archive","supplier_ship_from_locations.unarchive","representatives.create","representatives.update","representatives.archive","representatives.unarchive","payment_terms.create","payment_terms.update","ledger_accounts.create","ledger_accounts.update"]},"status":{"type":"string","enum":["ready","blocked"]},"wouldWrite":{"type":"boolean","enum":[false]},"submit":{"type":"object","properties":{"method":{"type":"string","enum":["POST","PATCH","PUT","DELETE"]},"path":{"type":"string"},"query":{"type":"object","properties":{},"additionalProperties":false}},"required":["method","path","query"],"additionalProperties":false},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false},"checks":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["not_direct_ship","address_role_required","address_role_valid","already_assigned","already_exists","active_duplicate","ambiguous_external_id","ambiguous_natural_key","api_created","archived_target","archived_record","archive_blocked","account_type_locked","duplicate_candidate_found","duplicate_candidate_overflow","duplicate_check_clear","duplicate_check_not_needed","duplicate_contact","duplicate_customer","duplicate_customer_address","duplicate_customer_location","duplicate_note","duplicate_resolution_applied","duplicate_supplier","duplicate_supplier_ship_from_location","document_url_org_scoped","document_url_valid","upload_verified","sds_converged","idempotency_available","idempotency_key_required","idempotency_key_reused","idempotency_replay","idempotency_target_missing","income_statement_type_invalid","hard_identity_clear","nested_external_id_clear","commercial_references_valid","credit_denomination_mismatch","customer_service_representative_reference_active","ledger_account_reference_valid","payment_terms_reference_exists","sales_person_reference_active","supplier_representative_reference_active","duplicate_reference_identity","external_id_conflict","if_match_current","base_uom_transition_allowed","base_uom_transition_blocked","attribute_assignments_valid","attribute_assignments_invalid","selected_supplier_link","linked_records_available","natural_key_conflict","not_api_created","no_downstream_mutation","order_sensitive_update_allowed","order_sensitive_update_blocked","parent_available","cost_book_entry_blocked","cost_book_entry_valid","cost_book_reference_not_visible","unsupported_cost_book_uom","cost_uom_conversion_unavailable","cost_book_base_unavailable","cost_book_base_ambiguous","cost_ship_from_location_not_visible","cost_package_quantity_invalid","cost_component_invalid","cost_date_window_invalid","cost_date_overlap","cost_amount_overflow","cost_book_conflict","product_family_reference_active","product_packaging_reference_active","primary_child_available","primary_change_unsupported","reference_visibility_blocked","scope_authorized","stale_record","stale_cost_book_entry","supplier_reference_active","tag_applicable","tag_available","tag_exists","tag_found","tag_not_applicable","tag_not_found","type_immutable","type_known","type_required","target_active","target_available","target_not_found_or_not_visible","targets_visible","unsupported_linked_record","unsupported_profile_shape","variable_qty_valid","validation_failed","value_nonempty"]},"status":{"type":"string","enum":["passed","blocked"]},"message":{"type":"string"},"param":{"type":"string"}},"required":["code","status","message"],"additionalProperties":false}},"duplicateCandidates":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact","customer","supplier","customer_location","customer_address","supplier_ship_from_location","product","product_family","document"]},"readable":{"type":"boolean"},"version":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","product","purchase_order"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"matchReasons":{"type":"array","items":{"type":"string","enum":["name","email","externalId","address","code","product","url"]}},"readbackPath":{"type":"string"}},"required":["type","readable","matchReasons"],"additionalProperties":false}},"idempotency":{"type":"object","properties":{"required":{"type":"boolean"},"keyProvided":{"type":"boolean"},"wouldReplay":{"type":"boolean"}},"required":["required","keyProvided","wouldReplay"],"additionalProperties":false},"wouldChange":{"type":"object","properties":{"fieldNames":{"type":"array","items":{"type":"string"}},"values":{"type":"object","additionalProperties":{}}},"required":["fieldNames","values"],"additionalProperties":false},"impactAnalysis":{"type":"object","additionalProperties":{}},"requestId":{"type":"string"}},"required":["type","operation","status","wouldWrite","submit","verification","checks","duplicateCandidates","requestId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}]}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested parent or record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"409":{"description":"The write conflicted with an existing record, idempotency payload, or stale If-Match value.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/customers/{id}/locations/{locationId}/addresses/{addressId}/archive":{"post":{"operationId":"archiveCustomerAddress","summary":"Archive a customer address","description":"Archives or restores one customer address under its selected customer and location. Preview with dryRun=true to review readiness and retrieve the current updatedAt value, then send it in If-Match to apply the action. The acting person must have current customer archive permission. The request may omit a body or use an empty JSON object.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"customers:write","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"locationId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"addressId","in":"path"},{"schema":{"type":"string","enum":["true"]},"required":false,"name":"dryRun","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check."},"required":false,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check.","name":"If-Match","in":"header"}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false}}}},"responses":{"200":{"description":"Lifecycle receipt or dry-run readiness.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["lifecycle_receipt"]},"resource":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","customer_contact","supplier_contact","customer_address","supplier_ship_from_location","representative","product","warehouse","shipping_option"]},"kind":{"type":"string","enum":["salesperson","customer_service","supplier"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},"action":{"type":"string","enum":["archive","unarchive"]},"archived":{"type":"boolean"},"changed":{"type":"boolean"},"updatedAt":{"type":"string","format":"date-time"},"requestId":{"type":"string"},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false}},"required":["type","resource","action","archived","changed","updatedAt","requestId","verification"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["write_readiness"]},"operation":{"type":"string","enum":["warehouses.create","warehouses.update","warehouses.archive","warehouses.unarchive","shipping_options.create","shipping_options.update","shipping_options.archive","shipping_options.unarchive","reorder_points.create","tags.create","tags.update","tag_assignments.create","tag_assignments.delete","notes.create","notes.update","opportunities.create","opportunities.update","opportunities.close","opportunities.meta-upsert","contacts.create","contacts.update","customers.create","customers.update","customer_locations.create","customer_locations.update","customer_addresses.create","customer_addresses.update","suppliers.create","suppliers.update","supplier_ship_from_locations.create","supplier_ship_from_locations.update","products.create","products.update","products.archive","products.unarchive","product_packaging.create","products.suppliers.create","products.suppliers.delete","products.aliases.create","products.aliases.update","products.aliases.delete","product_families.aliases.create","product_families.aliases.update","product_families.aliases.delete","products.customer_part_numbers.create","products.customer_part_numbers.update","products.customer_part_numbers.delete","product_sds.update","product_documents.create","customer_documents.create","supplier_documents.create","purchase_order_documents.create","product_families.create","product_families.update","cost_book_entries.create","current_cost_sources.put","customers.archive","customers.unarchive","suppliers.archive","suppliers.unarchive","contacts.archive","contacts.unarchive","customer_addresses.archive","customer_addresses.unarchive","supplier_ship_from_locations.archive","supplier_ship_from_locations.unarchive","representatives.create","representatives.update","representatives.archive","representatives.unarchive","payment_terms.create","payment_terms.update","ledger_accounts.create","ledger_accounts.update"]},"status":{"type":"string","enum":["ready","blocked"]},"wouldWrite":{"type":"boolean","enum":[false]},"submit":{"type":"object","properties":{"method":{"type":"string","enum":["POST","PATCH","PUT","DELETE"]},"path":{"type":"string"},"query":{"type":"object","properties":{},"additionalProperties":false}},"required":["method","path","query"],"additionalProperties":false},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false},"checks":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["not_direct_ship","address_role_required","address_role_valid","already_assigned","already_exists","active_duplicate","ambiguous_external_id","ambiguous_natural_key","api_created","archived_target","archived_record","archive_blocked","account_type_locked","duplicate_candidate_found","duplicate_candidate_overflow","duplicate_check_clear","duplicate_check_not_needed","duplicate_contact","duplicate_customer","duplicate_customer_address","duplicate_customer_location","duplicate_note","duplicate_resolution_applied","duplicate_supplier","duplicate_supplier_ship_from_location","document_url_org_scoped","document_url_valid","upload_verified","sds_converged","idempotency_available","idempotency_key_required","idempotency_key_reused","idempotency_replay","idempotency_target_missing","income_statement_type_invalid","hard_identity_clear","nested_external_id_clear","commercial_references_valid","credit_denomination_mismatch","customer_service_representative_reference_active","ledger_account_reference_valid","payment_terms_reference_exists","sales_person_reference_active","supplier_representative_reference_active","duplicate_reference_identity","external_id_conflict","if_match_current","base_uom_transition_allowed","base_uom_transition_blocked","attribute_assignments_valid","attribute_assignments_invalid","selected_supplier_link","linked_records_available","natural_key_conflict","not_api_created","no_downstream_mutation","order_sensitive_update_allowed","order_sensitive_update_blocked","parent_available","cost_book_entry_blocked","cost_book_entry_valid","cost_book_reference_not_visible","unsupported_cost_book_uom","cost_uom_conversion_unavailable","cost_book_base_unavailable","cost_book_base_ambiguous","cost_ship_from_location_not_visible","cost_package_quantity_invalid","cost_component_invalid","cost_date_window_invalid","cost_date_overlap","cost_amount_overflow","cost_book_conflict","product_family_reference_active","product_packaging_reference_active","primary_child_available","primary_change_unsupported","reference_visibility_blocked","scope_authorized","stale_record","stale_cost_book_entry","supplier_reference_active","tag_applicable","tag_available","tag_exists","tag_found","tag_not_applicable","tag_not_found","type_immutable","type_known","type_required","target_active","target_available","target_not_found_or_not_visible","targets_visible","unsupported_linked_record","unsupported_profile_shape","variable_qty_valid","validation_failed","value_nonempty"]},"status":{"type":"string","enum":["passed","blocked"]},"message":{"type":"string"},"param":{"type":"string"}},"required":["code","status","message"],"additionalProperties":false}},"duplicateCandidates":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact","customer","supplier","customer_location","customer_address","supplier_ship_from_location","product","product_family","document"]},"readable":{"type":"boolean"},"version":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","product","purchase_order"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"matchReasons":{"type":"array","items":{"type":"string","enum":["name","email","externalId","address","code","product","url"]}},"readbackPath":{"type":"string"}},"required":["type","readable","matchReasons"],"additionalProperties":false}},"idempotency":{"type":"object","properties":{"required":{"type":"boolean"},"keyProvided":{"type":"boolean"},"wouldReplay":{"type":"boolean"}},"required":["required","keyProvided","wouldReplay"],"additionalProperties":false},"wouldChange":{"type":"object","properties":{"fieldNames":{"type":"array","items":{"type":"string"}},"values":{"type":"object","additionalProperties":{}}},"required":["fieldNames","values"],"additionalProperties":false},"impactAnalysis":{"type":"object","additionalProperties":{}},"requestId":{"type":"string"}},"required":["type","operation","status","wouldWrite","submit","verification","checks","duplicateCandidates","requestId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}]}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested parent or record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"409":{"description":"The write conflicted with an existing record, idempotency payload, or stale If-Match value.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/customers/{id}/locations/{locationId}/addresses/{addressId}/unarchive":{"post":{"operationId":"unarchiveCustomerAddress","summary":"Restore a customer address","description":"Archives or restores one customer address under its selected customer and location. Preview with dryRun=true to review readiness and retrieve the current updatedAt value, then send it in If-Match to apply the action. The acting person must have current customer archive permission. The request may omit a body or use an empty JSON object.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"customers:write","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"locationId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"addressId","in":"path"},{"schema":{"type":"string","enum":["true"]},"required":false,"name":"dryRun","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check."},"required":false,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check.","name":"If-Match","in":"header"}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false}}}},"responses":{"200":{"description":"Lifecycle receipt or dry-run readiness.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["lifecycle_receipt"]},"resource":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","customer_contact","supplier_contact","customer_address","supplier_ship_from_location","representative","product","warehouse","shipping_option"]},"kind":{"type":"string","enum":["salesperson","customer_service","supplier"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},"action":{"type":"string","enum":["archive","unarchive"]},"archived":{"type":"boolean"},"changed":{"type":"boolean"},"updatedAt":{"type":"string","format":"date-time"},"requestId":{"type":"string"},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false}},"required":["type","resource","action","archived","changed","updatedAt","requestId","verification"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["write_readiness"]},"operation":{"type":"string","enum":["warehouses.create","warehouses.update","warehouses.archive","warehouses.unarchive","shipping_options.create","shipping_options.update","shipping_options.archive","shipping_options.unarchive","reorder_points.create","tags.create","tags.update","tag_assignments.create","tag_assignments.delete","notes.create","notes.update","opportunities.create","opportunities.update","opportunities.close","opportunities.meta-upsert","contacts.create","contacts.update","customers.create","customers.update","customer_locations.create","customer_locations.update","customer_addresses.create","customer_addresses.update","suppliers.create","suppliers.update","supplier_ship_from_locations.create","supplier_ship_from_locations.update","products.create","products.update","products.archive","products.unarchive","product_packaging.create","products.suppliers.create","products.suppliers.delete","products.aliases.create","products.aliases.update","products.aliases.delete","product_families.aliases.create","product_families.aliases.update","product_families.aliases.delete","products.customer_part_numbers.create","products.customer_part_numbers.update","products.customer_part_numbers.delete","product_sds.update","product_documents.create","customer_documents.create","supplier_documents.create","purchase_order_documents.create","product_families.create","product_families.update","cost_book_entries.create","current_cost_sources.put","customers.archive","customers.unarchive","suppliers.archive","suppliers.unarchive","contacts.archive","contacts.unarchive","customer_addresses.archive","customer_addresses.unarchive","supplier_ship_from_locations.archive","supplier_ship_from_locations.unarchive","representatives.create","representatives.update","representatives.archive","representatives.unarchive","payment_terms.create","payment_terms.update","ledger_accounts.create","ledger_accounts.update"]},"status":{"type":"string","enum":["ready","blocked"]},"wouldWrite":{"type":"boolean","enum":[false]},"submit":{"type":"object","properties":{"method":{"type":"string","enum":["POST","PATCH","PUT","DELETE"]},"path":{"type":"string"},"query":{"type":"object","properties":{},"additionalProperties":false}},"required":["method","path","query"],"additionalProperties":false},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false},"checks":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["not_direct_ship","address_role_required","address_role_valid","already_assigned","already_exists","active_duplicate","ambiguous_external_id","ambiguous_natural_key","api_created","archived_target","archived_record","archive_blocked","account_type_locked","duplicate_candidate_found","duplicate_candidate_overflow","duplicate_check_clear","duplicate_check_not_needed","duplicate_contact","duplicate_customer","duplicate_customer_address","duplicate_customer_location","duplicate_note","duplicate_resolution_applied","duplicate_supplier","duplicate_supplier_ship_from_location","document_url_org_scoped","document_url_valid","upload_verified","sds_converged","idempotency_available","idempotency_key_required","idempotency_key_reused","idempotency_replay","idempotency_target_missing","income_statement_type_invalid","hard_identity_clear","nested_external_id_clear","commercial_references_valid","credit_denomination_mismatch","customer_service_representative_reference_active","ledger_account_reference_valid","payment_terms_reference_exists","sales_person_reference_active","supplier_representative_reference_active","duplicate_reference_identity","external_id_conflict","if_match_current","base_uom_transition_allowed","base_uom_transition_blocked","attribute_assignments_valid","attribute_assignments_invalid","selected_supplier_link","linked_records_available","natural_key_conflict","not_api_created","no_downstream_mutation","order_sensitive_update_allowed","order_sensitive_update_blocked","parent_available","cost_book_entry_blocked","cost_book_entry_valid","cost_book_reference_not_visible","unsupported_cost_book_uom","cost_uom_conversion_unavailable","cost_book_base_unavailable","cost_book_base_ambiguous","cost_ship_from_location_not_visible","cost_package_quantity_invalid","cost_component_invalid","cost_date_window_invalid","cost_date_overlap","cost_amount_overflow","cost_book_conflict","product_family_reference_active","product_packaging_reference_active","primary_child_available","primary_change_unsupported","reference_visibility_blocked","scope_authorized","stale_record","stale_cost_book_entry","supplier_reference_active","tag_applicable","tag_available","tag_exists","tag_found","tag_not_applicable","tag_not_found","type_immutable","type_known","type_required","target_active","target_available","target_not_found_or_not_visible","targets_visible","unsupported_linked_record","unsupported_profile_shape","variable_qty_valid","validation_failed","value_nonempty"]},"status":{"type":"string","enum":["passed","blocked"]},"message":{"type":"string"},"param":{"type":"string"}},"required":["code","status","message"],"additionalProperties":false}},"duplicateCandidates":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact","customer","supplier","customer_location","customer_address","supplier_ship_from_location","product","product_family","document"]},"readable":{"type":"boolean"},"version":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","product","purchase_order"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"matchReasons":{"type":"array","items":{"type":"string","enum":["name","email","externalId","address","code","product","url"]}},"readbackPath":{"type":"string"}},"required":["type","readable","matchReasons"],"additionalProperties":false}},"idempotency":{"type":"object","properties":{"required":{"type":"boolean"},"keyProvided":{"type":"boolean"},"wouldReplay":{"type":"boolean"}},"required":["required","keyProvided","wouldReplay"],"additionalProperties":false},"wouldChange":{"type":"object","properties":{"fieldNames":{"type":"array","items":{"type":"string"}},"values":{"type":"object","additionalProperties":{}}},"required":["fieldNames","values"],"additionalProperties":false},"impactAnalysis":{"type":"object","additionalProperties":{}},"requestId":{"type":"string"}},"required":["type","operation","status","wouldWrite","submit","verification","checks","duplicateCandidates","requestId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}]}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested parent or record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"409":{"description":"The write conflicted with an existing record, idempotency payload, or stale If-Match value.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/suppliers/{id}/ship-from-locations/{locationId}/archive":{"post":{"operationId":"archiveSupplierShipFromLocation","summary":"Archive a supplier ship-from location","description":"Archives or restores one ship-from location under its selected supplier. Preview with dryRun=true to review readiness and retrieve the current updatedAt value, then send it in If-Match to apply the action. The acting person must have current supplier archive permission. The request may omit a body or use an empty JSON object.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"suppliers:write","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"locationId","in":"path"},{"schema":{"type":"string","enum":["true"]},"required":false,"name":"dryRun","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check."},"required":false,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check.","name":"If-Match","in":"header"}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false}}}},"responses":{"200":{"description":"Lifecycle receipt or dry-run readiness.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["lifecycle_receipt"]},"resource":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","customer_contact","supplier_contact","customer_address","supplier_ship_from_location","representative","product","warehouse","shipping_option"]},"kind":{"type":"string","enum":["salesperson","customer_service","supplier"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},"action":{"type":"string","enum":["archive","unarchive"]},"archived":{"type":"boolean"},"changed":{"type":"boolean"},"updatedAt":{"type":"string","format":"date-time"},"requestId":{"type":"string"},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false}},"required":["type","resource","action","archived","changed","updatedAt","requestId","verification"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["write_readiness"]},"operation":{"type":"string","enum":["warehouses.create","warehouses.update","warehouses.archive","warehouses.unarchive","shipping_options.create","shipping_options.update","shipping_options.archive","shipping_options.unarchive","reorder_points.create","tags.create","tags.update","tag_assignments.create","tag_assignments.delete","notes.create","notes.update","opportunities.create","opportunities.update","opportunities.close","opportunities.meta-upsert","contacts.create","contacts.update","customers.create","customers.update","customer_locations.create","customer_locations.update","customer_addresses.create","customer_addresses.update","suppliers.create","suppliers.update","supplier_ship_from_locations.create","supplier_ship_from_locations.update","products.create","products.update","products.archive","products.unarchive","product_packaging.create","products.suppliers.create","products.suppliers.delete","products.aliases.create","products.aliases.update","products.aliases.delete","product_families.aliases.create","product_families.aliases.update","product_families.aliases.delete","products.customer_part_numbers.create","products.customer_part_numbers.update","products.customer_part_numbers.delete","product_sds.update","product_documents.create","customer_documents.create","supplier_documents.create","purchase_order_documents.create","product_families.create","product_families.update","cost_book_entries.create","current_cost_sources.put","customers.archive","customers.unarchive","suppliers.archive","suppliers.unarchive","contacts.archive","contacts.unarchive","customer_addresses.archive","customer_addresses.unarchive","supplier_ship_from_locations.archive","supplier_ship_from_locations.unarchive","representatives.create","representatives.update","representatives.archive","representatives.unarchive","payment_terms.create","payment_terms.update","ledger_accounts.create","ledger_accounts.update"]},"status":{"type":"string","enum":["ready","blocked"]},"wouldWrite":{"type":"boolean","enum":[false]},"submit":{"type":"object","properties":{"method":{"type":"string","enum":["POST","PATCH","PUT","DELETE"]},"path":{"type":"string"},"query":{"type":"object","properties":{},"additionalProperties":false}},"required":["method","path","query"],"additionalProperties":false},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false},"checks":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["not_direct_ship","address_role_required","address_role_valid","already_assigned","already_exists","active_duplicate","ambiguous_external_id","ambiguous_natural_key","api_created","archived_target","archived_record","archive_blocked","account_type_locked","duplicate_candidate_found","duplicate_candidate_overflow","duplicate_check_clear","duplicate_check_not_needed","duplicate_contact","duplicate_customer","duplicate_customer_address","duplicate_customer_location","duplicate_note","duplicate_resolution_applied","duplicate_supplier","duplicate_supplier_ship_from_location","document_url_org_scoped","document_url_valid","upload_verified","sds_converged","idempotency_available","idempotency_key_required","idempotency_key_reused","idempotency_replay","idempotency_target_missing","income_statement_type_invalid","hard_identity_clear","nested_external_id_clear","commercial_references_valid","credit_denomination_mismatch","customer_service_representative_reference_active","ledger_account_reference_valid","payment_terms_reference_exists","sales_person_reference_active","supplier_representative_reference_active","duplicate_reference_identity","external_id_conflict","if_match_current","base_uom_transition_allowed","base_uom_transition_blocked","attribute_assignments_valid","attribute_assignments_invalid","selected_supplier_link","linked_records_available","natural_key_conflict","not_api_created","no_downstream_mutation","order_sensitive_update_allowed","order_sensitive_update_blocked","parent_available","cost_book_entry_blocked","cost_book_entry_valid","cost_book_reference_not_visible","unsupported_cost_book_uom","cost_uom_conversion_unavailable","cost_book_base_unavailable","cost_book_base_ambiguous","cost_ship_from_location_not_visible","cost_package_quantity_invalid","cost_component_invalid","cost_date_window_invalid","cost_date_overlap","cost_amount_overflow","cost_book_conflict","product_family_reference_active","product_packaging_reference_active","primary_child_available","primary_change_unsupported","reference_visibility_blocked","scope_authorized","stale_record","stale_cost_book_entry","supplier_reference_active","tag_applicable","tag_available","tag_exists","tag_found","tag_not_applicable","tag_not_found","type_immutable","type_known","type_required","target_active","target_available","target_not_found_or_not_visible","targets_visible","unsupported_linked_record","unsupported_profile_shape","variable_qty_valid","validation_failed","value_nonempty"]},"status":{"type":"string","enum":["passed","blocked"]},"message":{"type":"string"},"param":{"type":"string"}},"required":["code","status","message"],"additionalProperties":false}},"duplicateCandidates":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact","customer","supplier","customer_location","customer_address","supplier_ship_from_location","product","product_family","document"]},"readable":{"type":"boolean"},"version":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","product","purchase_order"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"matchReasons":{"type":"array","items":{"type":"string","enum":["name","email","externalId","address","code","product","url"]}},"readbackPath":{"type":"string"}},"required":["type","readable","matchReasons"],"additionalProperties":false}},"idempotency":{"type":"object","properties":{"required":{"type":"boolean"},"keyProvided":{"type":"boolean"},"wouldReplay":{"type":"boolean"}},"required":["required","keyProvided","wouldReplay"],"additionalProperties":false},"wouldChange":{"type":"object","properties":{"fieldNames":{"type":"array","items":{"type":"string"}},"values":{"type":"object","additionalProperties":{}}},"required":["fieldNames","values"],"additionalProperties":false},"impactAnalysis":{"type":"object","additionalProperties":{}},"requestId":{"type":"string"}},"required":["type","operation","status","wouldWrite","submit","verification","checks","duplicateCandidates","requestId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}]}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested parent or record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"409":{"description":"The write conflicted with an existing record, idempotency payload, or stale If-Match value.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/suppliers/{id}/ship-from-locations/{locationId}/unarchive":{"post":{"operationId":"unarchiveSupplierShipFromLocation","summary":"Restore a supplier ship-from location","description":"Archives or restores one ship-from location under its selected supplier. Preview with dryRun=true to review readiness and retrieve the current updatedAt value, then send it in If-Match to apply the action. The acting person must have current supplier archive permission. The request may omit a body or use an empty JSON object.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"suppliers:write","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"locationId","in":"path"},{"schema":{"type":"string","enum":["true"]},"required":false,"name":"dryRun","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check."},"required":false,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check.","name":"If-Match","in":"header"}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false}}}},"responses":{"200":{"description":"Lifecycle receipt or dry-run readiness.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["lifecycle_receipt"]},"resource":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","customer_contact","supplier_contact","customer_address","supplier_ship_from_location","representative","product","warehouse","shipping_option"]},"kind":{"type":"string","enum":["salesperson","customer_service","supplier"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},"action":{"type":"string","enum":["archive","unarchive"]},"archived":{"type":"boolean"},"changed":{"type":"boolean"},"updatedAt":{"type":"string","format":"date-time"},"requestId":{"type":"string"},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false}},"required":["type","resource","action","archived","changed","updatedAt","requestId","verification"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["write_readiness"]},"operation":{"type":"string","enum":["warehouses.create","warehouses.update","warehouses.archive","warehouses.unarchive","shipping_options.create","shipping_options.update","shipping_options.archive","shipping_options.unarchive","reorder_points.create","tags.create","tags.update","tag_assignments.create","tag_assignments.delete","notes.create","notes.update","opportunities.create","opportunities.update","opportunities.close","opportunities.meta-upsert","contacts.create","contacts.update","customers.create","customers.update","customer_locations.create","customer_locations.update","customer_addresses.create","customer_addresses.update","suppliers.create","suppliers.update","supplier_ship_from_locations.create","supplier_ship_from_locations.update","products.create","products.update","products.archive","products.unarchive","product_packaging.create","products.suppliers.create","products.suppliers.delete","products.aliases.create","products.aliases.update","products.aliases.delete","product_families.aliases.create","product_families.aliases.update","product_families.aliases.delete","products.customer_part_numbers.create","products.customer_part_numbers.update","products.customer_part_numbers.delete","product_sds.update","product_documents.create","customer_documents.create","supplier_documents.create","purchase_order_documents.create","product_families.create","product_families.update","cost_book_entries.create","current_cost_sources.put","customers.archive","customers.unarchive","suppliers.archive","suppliers.unarchive","contacts.archive","contacts.unarchive","customer_addresses.archive","customer_addresses.unarchive","supplier_ship_from_locations.archive","supplier_ship_from_locations.unarchive","representatives.create","representatives.update","representatives.archive","representatives.unarchive","payment_terms.create","payment_terms.update","ledger_accounts.create","ledger_accounts.update"]},"status":{"type":"string","enum":["ready","blocked"]},"wouldWrite":{"type":"boolean","enum":[false]},"submit":{"type":"object","properties":{"method":{"type":"string","enum":["POST","PATCH","PUT","DELETE"]},"path":{"type":"string"},"query":{"type":"object","properties":{},"additionalProperties":false}},"required":["method","path","query"],"additionalProperties":false},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false},"checks":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["not_direct_ship","address_role_required","address_role_valid","already_assigned","already_exists","active_duplicate","ambiguous_external_id","ambiguous_natural_key","api_created","archived_target","archived_record","archive_blocked","account_type_locked","duplicate_candidate_found","duplicate_candidate_overflow","duplicate_check_clear","duplicate_check_not_needed","duplicate_contact","duplicate_customer","duplicate_customer_address","duplicate_customer_location","duplicate_note","duplicate_resolution_applied","duplicate_supplier","duplicate_supplier_ship_from_location","document_url_org_scoped","document_url_valid","upload_verified","sds_converged","idempotency_available","idempotency_key_required","idempotency_key_reused","idempotency_replay","idempotency_target_missing","income_statement_type_invalid","hard_identity_clear","nested_external_id_clear","commercial_references_valid","credit_denomination_mismatch","customer_service_representative_reference_active","ledger_account_reference_valid","payment_terms_reference_exists","sales_person_reference_active","supplier_representative_reference_active","duplicate_reference_identity","external_id_conflict","if_match_current","base_uom_transition_allowed","base_uom_transition_blocked","attribute_assignments_valid","attribute_assignments_invalid","selected_supplier_link","linked_records_available","natural_key_conflict","not_api_created","no_downstream_mutation","order_sensitive_update_allowed","order_sensitive_update_blocked","parent_available","cost_book_entry_blocked","cost_book_entry_valid","cost_book_reference_not_visible","unsupported_cost_book_uom","cost_uom_conversion_unavailable","cost_book_base_unavailable","cost_book_base_ambiguous","cost_ship_from_location_not_visible","cost_package_quantity_invalid","cost_component_invalid","cost_date_window_invalid","cost_date_overlap","cost_amount_overflow","cost_book_conflict","product_family_reference_active","product_packaging_reference_active","primary_child_available","primary_change_unsupported","reference_visibility_blocked","scope_authorized","stale_record","stale_cost_book_entry","supplier_reference_active","tag_applicable","tag_available","tag_exists","tag_found","tag_not_applicable","tag_not_found","type_immutable","type_known","type_required","target_active","target_available","target_not_found_or_not_visible","targets_visible","unsupported_linked_record","unsupported_profile_shape","variable_qty_valid","validation_failed","value_nonempty"]},"status":{"type":"string","enum":["passed","blocked"]},"message":{"type":"string"},"param":{"type":"string"}},"required":["code","status","message"],"additionalProperties":false}},"duplicateCandidates":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact","customer","supplier","customer_location","customer_address","supplier_ship_from_location","product","product_family","document"]},"readable":{"type":"boolean"},"version":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","product","purchase_order"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"matchReasons":{"type":"array","items":{"type":"string","enum":["name","email","externalId","address","code","product","url"]}},"readbackPath":{"type":"string"}},"required":["type","readable","matchReasons"],"additionalProperties":false}},"idempotency":{"type":"object","properties":{"required":{"type":"boolean"},"keyProvided":{"type":"boolean"},"wouldReplay":{"type":"boolean"}},"required":["required","keyProvided","wouldReplay"],"additionalProperties":false},"wouldChange":{"type":"object","properties":{"fieldNames":{"type":"array","items":{"type":"string"}},"values":{"type":"object","additionalProperties":{}}},"required":["fieldNames","values"],"additionalProperties":false},"impactAnalysis":{"type":"object","additionalProperties":{}},"requestId":{"type":"string"}},"required":["type","operation","status","wouldWrite","submit","verification","checks","duplicateCandidates","requestId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}]}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested parent or record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"409":{"description":"The write conflicted with an existing record, idempotency payload, or stale If-Match value.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/openapi.json":{"get":{"operationId":"getPublicAPIOpenAPISpec","summary":"Get the generated OpenAPI specification","description":"Returns the public, CORS-open OpenAPI 3.1 document for the ShelfCycle public API.","tags":["Public API v1"],"security":[],"x-required-scope":null,"responses":{"200":{"description":"Generated OpenAPI 3.1 document.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"openapi":{"type":"string"},"info":{"type":"object","properties":{"title":{"type":"string"},"version":{"type":"string"}},"required":["title","version"],"additionalProperties":false}},"required":["openapi","info"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/me":{"get":{"operationId":"getPublicAPIMe","summary":"Inspect the authenticated API key","description":"Returns org, key, acting user, documentation links, and effective capabilities derived from key scopes plus current ShelfCycle access. Use dryRun=true on write endpoints for target-specific visibility, archived state, idempotency, duplicate, concurrency, and shape checks.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":null,"responses":{"200":{"description":"Authenticated API key, acting user, documentation, and effective capabilities.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"apiVersion":{"type":"string","enum":["v1"]},"apiContractVersion":{"type":"string","enum":["v1.47.0"]},"minimumCompatibleContractVersion":{"type":"string","enum":["v1.21"]},"org":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"baseCurrencyCode":{"type":"string","minLength":3,"maxLength":3}},"required":["id","name","baseCurrencyCode"],"additionalProperties":false},"key":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"purpose":{"type":["string","null"]},"preview":{"type":"string"},"scopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"accessMode":{"type":"string","enum":["restricted","full"]},"storedGrants":{"type":"array","items":{"type":"string"}},"effectiveScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"retiredScopes":{"type":"array","items":{"type":"string"}},"expiresAt":{"type":["string","null"],"format":"date-time"}},"required":["id","name","purpose","preview","scopes","accessMode","storedGrants","effectiveScopes","retiredScopes","expiresAt"],"additionalProperties":false},"actor":{"type":"object","properties":{"type":{"type":"string","enum":["user"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"documentation":{"type":"object","properties":{"openapiJsonUrl":{"type":"string"},"llmsTxtUrl":{"type":"string"}},"required":["openapiJsonUrl","llmsTxtUrl"],"additionalProperties":false},"effectiveCapabilities":{"type":"object","properties":{"documentUploads":{"type":"object","properties":{"create":{"type":"boolean"}},"required":["create"],"additionalProperties":false},"search":{"type":"object","properties":{"viewableTypes":{"type":"array","items":{"type":"string","enum":["customer","supplier","contact","product","order","purchase_order","location"]}}},"required":["viewableTypes"],"additionalProperties":false},"entityResolution":{"type":"object","properties":{"viewableClasses":{"type":"array","items":{"type":"string","enum":["customer","supplier","product","product_family","sales_order","purchase_order","salesperson","warehouse"]}}},"required":["viewableClasses"],"additionalProperties":false},"warehouses":{"type":"object","properties":{"view":{"type":"boolean"},"create":{"type":"boolean"},"update":{"type":"boolean"},"archive":{"type":"boolean"},"unarchive":{"type":"boolean"}},"required":["view","create","update","archive","unarchive"],"additionalProperties":false},"shippingOptions":{"type":"object","properties":{"view":{"type":"boolean"},"create":{"type":"boolean"},"update":{"type":"boolean"},"archive":{"type":"boolean"},"unarchive":{"type":"boolean"}},"required":["view","create","update","archive","unarchive"],"additionalProperties":false},"reorderPoints":{"type":"object","properties":{"write":{"type":"boolean"}},"required":["write"],"additionalProperties":false},"tags":{"type":"object","properties":{"vocabulary":{"type":"boolean"},"viewableEntityTypes":{"type":"array","items":{"type":"string","enum":["supplier","customer","product","product_family","contact","opportunity","sales_order","purchase_order","ship_to_address","ship_from_address"]}}},"required":["vocabulary","viewableEntityTypes"],"additionalProperties":false},"productDirectory":{"type":"object","properties":{"view":{"type":"boolean"},"createdRecordDiscovery":{"type":"boolean"}},"required":["view","createdRecordDiscovery"],"additionalProperties":false},"notes":{"type":"object","properties":{"create":{"type":"boolean"},"view":{"type":"boolean"},"update":{"type":"boolean"},"activityReport":{"type":"boolean"},"viewableSubjectTypes":{"type":"array","items":{"type":"string","enum":["customer","supplier","product"]}},"readableSubjectTypes":{"type":"array","items":{"type":"string","enum":["customer","supplier","product"]}}},"required":["create","view","update","activityReport","viewableSubjectTypes","readableSubjectTypes"],"additionalProperties":false},"sentEmails":{"type":"object","properties":{"activityReport":{"type":"boolean"}},"required":["activityReport"],"additionalProperties":false},"opportunities":{"type":"object","properties":{"view":{"type":"boolean"},"createdRecordDiscovery":{"type":"boolean"},"create":{"type":"boolean"},"update":{"type":"boolean"},"close":{"type":"boolean"},"metaUpsert":{"type":"boolean"}},"required":["view","createdRecordDiscovery","create","update","close","metaUpsert"],"additionalProperties":false},"contacts":{"type":"object","properties":{"create":{"type":"boolean"},"view":{"type":"boolean"},"update":{"type":"boolean"},"archive":{"type":"boolean"},"unarchive":{"type":"boolean"},"customer":{"type":"object","properties":{"create":{"type":"boolean"},"view":{"type":"boolean"},"update":{"type":"boolean"},"archive":{"type":"boolean"},"unarchive":{"type":"boolean"}},"required":["create","view","update","archive","unarchive"],"additionalProperties":false},"supplier":{"type":"object","properties":{"create":{"type":"boolean"},"view":{"type":"boolean"},"update":{"type":"boolean"},"archive":{"type":"boolean"},"unarchive":{"type":"boolean"}},"required":["create","view","update","archive","unarchive"],"additionalProperties":false}},"required":["create","view","update","archive","unarchive","customer","supplier"],"additionalProperties":false},"customers":{"type":"object","properties":{"view":{"type":"boolean"},"create":{"type":"boolean"},"update":{"type":"boolean"},"archive":{"type":"boolean"},"unarchive":{"type":"boolean"},"activityFilter":{"type":"boolean"},"createdRecordDiscovery":{"type":"boolean"},"locations":{"type":"object","properties":{"view":{"type":"boolean"},"create":{"type":"boolean"},"update":{"type":"boolean"}},"required":["view","create","update"],"additionalProperties":false},"addresses":{"type":"object","properties":{"view":{"type":"boolean"},"create":{"type":"boolean"},"update":{"type":"boolean"},"archive":{"type":"boolean"},"unarchive":{"type":"boolean"}},"required":["view","create","update","archive","unarchive"],"additionalProperties":false},"documents":{"type":"object","properties":{"view":{"type":"boolean"},"create":{"type":"boolean"}},"required":["view","create"],"additionalProperties":false}},"required":["view","create","update","archive","unarchive","activityFilter","createdRecordDiscovery","locations","addresses","documents"],"additionalProperties":false},"suppliers":{"type":"object","properties":{"view":{"type":"boolean"},"createdRecordDiscovery":{"type":"boolean"},"create":{"type":"boolean"},"update":{"type":"boolean"},"archive":{"type":"boolean"},"unarchive":{"type":"boolean"},"shipFromLocations":{"type":"object","properties":{"view":{"type":"boolean"},"create":{"type":"boolean"},"update":{"type":"boolean"},"archive":{"type":"boolean"},"unarchive":{"type":"boolean"}},"required":["view","create","update","archive","unarchive"],"additionalProperties":false},"documents":{"type":"object","properties":{"view":{"type":"boolean"},"create":{"type":"boolean"}},"required":["view","create"],"additionalProperties":false}},"required":["view","createdRecordDiscovery","create","update","archive","unarchive","shipFromLocations","documents"],"additionalProperties":false},"companyReference":{"type":"object","properties":{"activeDirectory":{"type":"boolean"},"customers":{"type":"boolean"},"suppliers":{"type":"boolean"},"representatives":{"type":"boolean"},"paymentTerms":{"type":"boolean"},"ledgerAccounts":{"type":"boolean"},"write":{"type":"object","properties":{"salesRepresentatives":{"type":"boolean"},"customerServiceRepresentatives":{"type":"boolean"},"supplierRepresentatives":{"type":"boolean"},"paymentTermsCreate":{"type":"boolean"},"paymentTermsMetadataUpdate":{"type":"boolean"},"ledgerAccountsCreate":{"type":"boolean"},"ledgerAccountsUpdate":{"type":"boolean"}},"required":["salesRepresentatives","customerServiceRepresentatives","supplierRepresentatives","paymentTermsCreate","paymentTermsMetadataUpdate","ledgerAccountsCreate","ledgerAccountsUpdate"],"additionalProperties":false}},"required":["activeDirectory","customers","suppliers","representatives","paymentTerms","ledgerAccounts","write"],"additionalProperties":false},"products":{"type":"object","properties":{"view":{"type":"boolean"},"create":{"type":"boolean"},"update":{"type":"boolean"},"archive":{"type":"boolean"},"unarchive":{"type":"boolean"},"packaging":{"type":"object","properties":{"view":{"type":"boolean"},"create":{"type":"boolean"}},"required":["view","create"],"additionalProperties":false},"codeAttributes":{"type":"object","properties":{"view":{"type":"boolean"}},"required":["view"],"additionalProperties":false},"attributeAssignments":{"type":"object","properties":{"view":{"type":"boolean"},"update":{"type":"boolean"}},"required":["view","update"],"additionalProperties":false},"suppliers":{"type":"object","properties":{"view":{"type":"boolean"},"create":{"type":"boolean"},"remove":{"type":"boolean"}},"required":["view","create","remove"],"additionalProperties":false},"aliases":{"type":"object","properties":{"view":{"type":"boolean"},"create":{"type":"boolean"},"update":{"type":"boolean"},"remove":{"type":"boolean"}},"required":["view","create","update","remove"],"additionalProperties":false},"customerPartNumbers":{"type":"object","properties":{"view":{"type":"boolean"},"create":{"type":"boolean"},"update":{"type":"boolean"},"remove":{"type":"boolean"}},"required":["view","create","update","remove"],"additionalProperties":false},"documents":{"type":"object","properties":{"view":{"type":"boolean"},"create":{"type":"boolean"}},"required":["view","create"],"additionalProperties":false},"sds":{"type":"object","properties":{"view":{"type":"boolean"},"update":{"type":"boolean"}},"required":["view","update"],"additionalProperties":false}},"required":["view","create","update","archive","unarchive","packaging","codeAttributes","attributeAssignments","suppliers","aliases","customerPartNumbers","documents","sds"],"additionalProperties":false},"productFamilies":{"type":"object","properties":{"view":{"type":"boolean"},"create":{"type":"boolean"},"update":{"type":"boolean"},"aliases":{"type":"object","properties":{"view":{"type":"boolean"},"create":{"type":"boolean"},"update":{"type":"boolean"},"remove":{"type":"boolean"}},"required":["view","create","update","remove"],"additionalProperties":false}},"required":["view","create","update","aliases"],"additionalProperties":false},"costBookEntries":{"type":"object","properties":{"view":{"type":"boolean"},"createdRecordDiscovery":{"type":"boolean"},"create":{"type":"boolean"},"delete":{"type":"boolean"}},"required":["view","createdRecordDiscovery","create","delete"],"additionalProperties":false},"currentCostSources":{"type":"object","properties":{"read":{"type":"boolean"},"write":{"type":"boolean"}},"required":["read","write"],"additionalProperties":false},"priceBookEntries":{"type":"object","properties":{"read":{"type":"boolean"},"createdRecordDiscovery":{"type":"boolean"},"write":{"type":"boolean"},"writeCurrencyMode":{"type":"string","enum":["org_base_only"]}},"required":["read","createdRecordDiscovery","write","writeCurrencyMode"],"additionalProperties":false},"orders":{"type":"object","properties":{"view":{"type":"boolean"},"createdRecordDiscovery":{"type":"boolean"},"changedRecordDiscovery":{"type":"boolean"}},"required":["view","createdRecordDiscovery","changedRecordDiscovery"],"additionalProperties":false},"purchaseOrders":{"type":"object","properties":{"view":{"type":"boolean"},"createdRecordDiscovery":{"type":"boolean"},"changedRecordDiscovery":{"type":"boolean"},"execution":{"type":"object","properties":{"view":{"type":"boolean"},"currentStateRefresh":{"type":"boolean"}},"required":["view","currentStateRefresh"],"additionalProperties":false},"documents":{"type":"object","properties":{"view":{"type":"boolean"},"create":{"type":"boolean"}},"required":["view","create"],"additionalProperties":false}},"required":["view","createdRecordDiscovery","changedRecordDiscovery","execution","documents"],"additionalProperties":false},"inventory":{"type":"object","properties":{"balances":{"type":"object","properties":{"view":{"type":"boolean"},"currentStateRefresh":{"type":"boolean"}},"required":["view","currentStateRefresh"],"additionalProperties":false},"lots":{"type":"object","properties":{"view":{"type":"boolean"},"createdRecordDiscovery":{"type":"boolean"},"currentStateRefresh":{"type":"boolean"}},"required":["view","createdRecordDiscovery","currentStateRefresh"],"additionalProperties":false}},"required":["balances","lots"],"additionalProperties":false},"reorder":{"type":"object","properties":{"status":{"type":"object","properties":{"view":{"type":"boolean"},"currentStateRefresh":{"type":"boolean"}},"required":["view","currentStateRefresh"],"additionalProperties":false}},"required":["status"],"additionalProperties":false},"certifications":{"type":"object","properties":{"view":{"type":"boolean"},"createdRecordDiscovery":{"type":"boolean"},"viewableSubjectTypes":{"type":"array","items":{"type":"string","enum":["supplier","customer","product","customer_address","warehouse","supplier_combination"]}}},"required":["view","createdRecordDiscovery","viewableSubjectTypes"],"additionalProperties":false},"reports":{"type":"object","properties":{"available":{"type":"array","items":{"type":"string","enum":["sales-summary","purchase-summary","open-sales-orders","ap-aging","payments-received","payments-made","ar-aging","pipeline-summary","customer-invoice-settlement-behavior","customer-credit-exposure","customer-invoice-charges"]}}},"required":["available"],"additionalProperties":false},"writeReadiness":{"type":"object","properties":{"warehouses":{"type":"object","properties":{"create":{"type":"boolean"},"update":{"type":"boolean"},"archive":{"type":"boolean"},"unarchive":{"type":"boolean"}},"required":["create","update","archive","unarchive"],"additionalProperties":false},"shippingOptions":{"type":"object","properties":{"create":{"type":"boolean"},"update":{"type":"boolean"},"archive":{"type":"boolean"},"unarchive":{"type":"boolean"}},"required":["create","update","archive","unarchive"],"additionalProperties":false},"reorderPoints":{"type":"object","properties":{"write":{"type":"boolean"}},"required":["write"],"additionalProperties":false},"tags":{"type":"object","properties":{"create":{"type":"boolean"},"update":{"type":"boolean"},"assignableEntityTypes":{"type":"array","items":{"type":"string","enum":["supplier","customer","product","product_family","contact","opportunity","sales_order","purchase_order","ship_to_address","ship_from_address"]}}},"required":["create","update","assignableEntityTypes"],"additionalProperties":false},"notes":{"type":"object","properties":{"create":{"type":"boolean"},"update":{"type":"boolean"}},"required":["create","update"],"additionalProperties":false},"opportunities":{"type":"object","properties":{"create":{"type":"boolean"},"update":{"type":"boolean"},"close":{"type":"boolean"},"metaUpsert":{"type":"boolean"}},"required":["create","update","close","metaUpsert"],"additionalProperties":false},"contacts":{"type":"object","properties":{"create":{"type":"boolean"},"update":{"type":"boolean"},"archive":{"type":"boolean"},"unarchive":{"type":"boolean"},"customer":{"type":"object","properties":{"create":{"type":"boolean"},"update":{"type":"boolean"},"archive":{"type":"boolean"},"unarchive":{"type":"boolean"}},"required":["create","update","archive","unarchive"],"additionalProperties":false},"supplier":{"type":"object","properties":{"create":{"type":"boolean"},"update":{"type":"boolean"},"archive":{"type":"boolean"},"unarchive":{"type":"boolean"}},"required":["create","update","archive","unarchive"],"additionalProperties":false}},"required":["create","update","archive","unarchive","customer","supplier"],"additionalProperties":false},"customers":{"type":"object","properties":{"create":{"type":"boolean"},"update":{"type":"boolean"},"archive":{"type":"boolean"},"unarchive":{"type":"boolean"},"locations":{"type":"object","properties":{"create":{"type":"boolean"},"update":{"type":"boolean"}},"required":["create","update"],"additionalProperties":false},"addresses":{"type":"object","properties":{"create":{"type":"boolean"},"update":{"type":"boolean"},"archive":{"type":"boolean"},"unarchive":{"type":"boolean"}},"required":["create","update","archive","unarchive"],"additionalProperties":false},"documents":{"type":"object","properties":{"create":{"type":"boolean"}},"required":["create"],"additionalProperties":false}},"required":["create","update","archive","unarchive","locations","addresses","documents"],"additionalProperties":false},"suppliers":{"type":"object","properties":{"create":{"type":"boolean"},"update":{"type":"boolean"},"archive":{"type":"boolean"},"unarchive":{"type":"boolean"},"shipFromLocations":{"type":"object","properties":{"create":{"type":"boolean"},"update":{"type":"boolean"},"archive":{"type":"boolean"},"unarchive":{"type":"boolean"}},"required":["create","update","archive","unarchive"],"additionalProperties":false},"documents":{"type":"object","properties":{"create":{"type":"boolean"}},"required":["create"],"additionalProperties":false}},"required":["create","update","archive","unarchive","shipFromLocations","documents"],"additionalProperties":false},"products":{"type":"object","properties":{"create":{"type":"boolean"},"update":{"type":"boolean"},"archive":{"type":"boolean"},"unarchive":{"type":"boolean"},"packaging":{"type":"object","properties":{"create":{"type":"boolean"}},"required":["create"],"additionalProperties":false},"suppliers":{"type":"object","properties":{"create":{"type":"boolean"},"remove":{"type":"boolean"}},"required":["create","remove"],"additionalProperties":false},"aliases":{"type":"object","properties":{"create":{"type":"boolean"},"update":{"type":"boolean"},"remove":{"type":"boolean"}},"required":["create","update","remove"],"additionalProperties":false},"customerPartNumbers":{"type":"object","properties":{"create":{"type":"boolean"},"update":{"type":"boolean"},"remove":{"type":"boolean"}},"required":["create","update","remove"],"additionalProperties":false},"documents":{"type":"object","properties":{"create":{"type":"boolean"}},"required":["create"],"additionalProperties":false},"sds":{"type":"object","properties":{"update":{"type":"boolean"}},"required":["update"],"additionalProperties":false}},"required":["create","update","archive","unarchive","packaging","suppliers","aliases","customerPartNumbers","documents","sds"],"additionalProperties":false},"productFamilies":{"type":"object","properties":{"create":{"type":"boolean"},"update":{"type":"boolean"},"aliases":{"type":"object","properties":{"create":{"type":"boolean"},"update":{"type":"boolean"},"remove":{"type":"boolean"}},"required":["create","update","remove"],"additionalProperties":false}},"required":["create","update","aliases"],"additionalProperties":false},"costBookEntries":{"type":"object","properties":{"create":{"type":"boolean"},"delete":{"type":"boolean"}},"required":["create","delete"],"additionalProperties":false},"currentCostSources":{"type":"object","properties":{"write":{"type":"boolean"}},"required":["write"],"additionalProperties":false},"priceBookEntries":{"type":"object","properties":{"create":{"type":"boolean"}},"required":["create"],"additionalProperties":false},"purchaseOrders":{"type":"object","properties":{"documents":{"type":"object","properties":{"create":{"type":"boolean"}},"required":["create"],"additionalProperties":false}},"required":["documents"],"additionalProperties":false}},"required":["warehouses","shippingOptions","reorderPoints","tags","notes","opportunities","contacts","customers","suppliers","products","productFamilies","costBookEntries","currentCostSources","priceBookEntries","purchaseOrders"],"additionalProperties":false}},"required":["documentUploads","search","entityResolution","warehouses","shippingOptions","reorderPoints","tags","productDirectory","notes","sentEmails","opportunities","contacts","customers","suppliers","companyReference","products","productFamilies","costBookEntries","currentCostSources","priceBookEntries","orders","purchaseOrders","inventory","reorder","certifications","reports","writeReadiness"],"additionalProperties":false},"provenance":{"type":"object","properties":{"apiKeyId":{"type":"string","format":"uuid"},"purpose":{"type":["string","null"]}},"required":["apiKeyId","purpose"],"additionalProperties":false}},"required":["apiVersion","apiContractVersion","minimumCompatibleContractVersion","org","key","actor","documentation","effectiveCapabilities","provenance"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/search":{"get":{"operationId":"searchPublicAPIRecords","summary":"Search public API records","description":"Resolves customers, suppliers, contacts, products, sales orders, purchase orders, and locations visible to the acting user. Cards are resolver hints only and never include money, line items, costs, documents, inventory, or margin fields.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"search:read","deprecated":true,"parameters":[{"schema":{"type":"string","minLength":2,"maxLength":120},"required":true,"name":"q","in":"query"},{"schema":{"type":"string"},"required":false,"name":"types","in":"query"},{"schema":{"type":"string"},"required":false,"name":"limit","in":"query"}],"responses":{"200":{"description":"Search result cards and request metadata.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","contact","product","order","purchase_order","location"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"subtitle":{"type":"string"},"url":{"type":"string"},"archived":{"type":"boolean"},"matchedFields":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"label":{"type":"string"},"value":{"type":"string"}},"required":["field","label","value"],"additionalProperties":false}},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false}},"required":["type","id","displayName","subtitle","url","archived","matchedFields"],"additionalProperties":false}},"meta":{"type":"object","properties":{"requestId":{"type":"string"},"limit":{"type":"integer"},"types":{"type":"array","items":{"type":"string","enum":["customer","supplier","contact","product","order","purchase_order","location"]}},"rankingIsContractual":{"type":"boolean","enum":[false]},"truncated":{"type":"boolean"},"durationMs":{"type":"number"}},"required":["requestId","limit","types","rankingIsContractual","truncated","durationMs"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/entity-resolution":{"get":{"operationId":"resolvePublicAPIEntity","summary":"Resolve wording to an authorized entity","description":"Binds human wording to one customer, supplier, product, product family, sales order, or purchase order class using the same matching behavior as ShelfCycle Assistant. Unique, ambiguous, and missing outcomes all return HTTP 200. A class=product request can select a product family when the wording identifies the family more clearly than one product; check selectedCandidate.matchedClass before using the returned ID. Matching considers only the first 12 whitespace- or punctuation-separated tokens of q. relatedTags is included only when the key also grants tags:read and the acting person has current Tags access.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"search:read","parameters":[{"schema":{"type":"string","minLength":1,"maxLength":200,"pattern":"[\\p{L}\\p{N}]"},"required":true,"name":"q","in":"query"},{"schema":{"type":"string","enum":["customer","supplier","product","product_family","sales_order","purchase_order","salesperson","warehouse"]},"required":true,"name":"class","in":"query"}],"responses":{"200":{"description":"Entity Resolution candidates and selection status.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"oneOf":[{"type":"object","properties":{"classesSearched":{"type":"array","items":{"type":"string","enum":["customer","supplier","product","product_family","sales_order","purchase_order","salesperson","warehouse"]},"minItems":1},"classResults":{"type":"array","items":{"type":"object","properties":{"matchedClass":{"type":"string","enum":["customer","supplier","product","product_family","sales_order","purchase_order","salesperson","warehouse"]},"totalMatches":{"type":"integer","minimum":0}},"required":["matchedClass","totalMatches"],"additionalProperties":false}},"candidates":{"type":"array","items":{"type":"object","properties":{"entityId":{"type":"string","format":"uuid"},"displayName":{"type":"string","minLength":1,"maxLength":300},"matchedClass":{"type":"string","enum":["customer","supplier","product","product_family","sales_order","purchase_order","salesperson","warehouse"]},"matchRank":{"type":"string","enum":["exact","prefix","contains"]},"matchBasis":{"type":"string","enum":["canonical","product_code","external_id","alias","family","packaging","location","compound"]},"matchedValue":{"type":"string","minLength":1,"maxLength":300},"productCodes":{"type":"array","items":{"type":"string","minLength":1,"maxLength":120},"maxItems":50},"productIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":25},"memberCount":{"type":"integer","minimum":0},"productCodesComplete":{"type":"boolean"},"productIdsComplete":{"type":"boolean"}},"required":["entityId","displayName","matchedClass","matchRank","matchBasis","matchedValue"],"additionalProperties":false},"maxItems":30},"archivedRecordsExcluded":{"type":"boolean","enum":[true]},"selectionStatus":{"type":"string","enum":["auto_selected"]},"selectedCandidate":{"type":"object","properties":{"entityId":{"type":"string","format":"uuid"},"matchedClass":{"type":"string","enum":["customer","supplier","product","product_family","sales_order","purchase_order","salesperson","warehouse"]}},"required":["entityId","matchedClass"],"additionalProperties":false},"relatedTags":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","minLength":1},"description":{"type":["string","null"]},"matchedClasses":{"type":"array","items":{"type":"string","enum":["supplier","customer","product","product_family","contact","opportunity","sales_order","purchase_order","ship_to_address","ship_from_address"]},"maxItems":10}},"required":["label","description","matchedClasses"],"additionalProperties":false},"maxItems":5}},"required":["classesSearched","classResults","candidates","archivedRecordsExcluded","selectionStatus","selectedCandidate"],"additionalProperties":false},{"type":"object","properties":{"classesSearched":{"type":"array","items":{"type":"string","enum":["customer","supplier","product","product_family","sales_order","purchase_order","salesperson","warehouse"]},"minItems":1},"classResults":{"type":"array","items":{"type":"object","properties":{"matchedClass":{"type":"string","enum":["customer","supplier","product","product_family","sales_order","purchase_order","salesperson","warehouse"]},"totalMatches":{"type":"integer","minimum":0}},"required":["matchedClass","totalMatches"],"additionalProperties":false}},"candidates":{"type":"array","items":{"type":"object","properties":{"entityId":{"type":"string","format":"uuid"},"displayName":{"type":"string","minLength":1,"maxLength":300},"matchedClass":{"type":"string","enum":["customer","supplier","product","product_family","sales_order","purchase_order","salesperson","warehouse"]},"matchRank":{"type":"string","enum":["exact","prefix","contains"]},"matchBasis":{"type":"string","enum":["canonical","product_code","external_id","alias","family","packaging","location","compound"]},"matchedValue":{"type":"string","minLength":1,"maxLength":300},"productCodes":{"type":"array","items":{"type":"string","minLength":1,"maxLength":120},"maxItems":50},"productIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":25},"memberCount":{"type":"integer","minimum":0},"productCodesComplete":{"type":"boolean"},"productIdsComplete":{"type":"boolean"}},"required":["entityId","displayName","matchedClass","matchRank","matchBasis","matchedValue"],"additionalProperties":false},"maxItems":30},"archivedRecordsExcluded":{"type":"boolean","enum":[true]},"selectionStatus":{"type":"string","enum":["needs_clarification"]},"relatedTags":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","minLength":1},"description":{"type":["string","null"]},"matchedClasses":{"type":"array","items":{"type":"string","enum":["supplier","customer","product","product_family","contact","opportunity","sales_order","purchase_order","ship_to_address","ship_from_address"]},"maxItems":10}},"required":["label","description","matchedClasses"],"additionalProperties":false},"maxItems":5}},"required":["classesSearched","classResults","candidates","archivedRecordsExcluded","selectionStatus"],"additionalProperties":false},{"type":"object","properties":{"classesSearched":{"type":"array","items":{"type":"string","enum":["customer","supplier","product","product_family","sales_order","purchase_order","salesperson","warehouse"]},"minItems":1},"classResults":{"type":"array","items":{"type":"object","properties":{"matchedClass":{"type":"string","enum":["customer","supplier","product","product_family","sales_order","purchase_order","salesperson","warehouse"]},"totalMatches":{"type":"integer","minimum":0}},"required":["matchedClass","totalMatches"],"additionalProperties":false}},"candidates":{"type":"array","items":{"type":"object","properties":{"entityId":{"type":"string","format":"uuid"},"displayName":{"type":"string","minLength":1,"maxLength":300},"matchedClass":{"type":"string","enum":["customer","supplier","product","product_family","sales_order","purchase_order","salesperson","warehouse"]},"matchRank":{"type":"string","enum":["exact","prefix","contains"]},"matchBasis":{"type":"string","enum":["canonical","product_code","external_id","alias","family","packaging","location","compound"]},"matchedValue":{"type":"string","minLength":1,"maxLength":300},"productCodes":{"type":"array","items":{"type":"string","minLength":1,"maxLength":120},"maxItems":50},"productIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":25},"memberCount":{"type":"integer","minimum":0},"productCodesComplete":{"type":"boolean"},"productIdsComplete":{"type":"boolean"}},"required":["entityId","displayName","matchedClass","matchRank","matchBasis","matchedValue"],"additionalProperties":false},"maxItems":30},"archivedRecordsExcluded":{"type":"boolean","enum":[true]},"selectionStatus":{"type":"string","enum":["no_match"]},"relatedTags":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","minLength":1},"description":{"type":["string","null"]},"matchedClasses":{"type":"array","items":{"type":"string","enum":["supplier","customer","product","product_family","contact","opportunity","sales_order","purchase_order","ship_to_address","ship_from_address"]},"maxItems":10}},"required":["label","description","matchedClasses"],"additionalProperties":false},"maxItems":5}},"required":["classesSearched","classResults","candidates","archivedRecordsExcluded","selectionStatus"],"additionalProperties":false}]},"meta":{"type":"object","properties":{"capabilityKey":{"type":"string","enum":["resolve_entity"]},"capabilityVersion":{"type":"string","enum":["1.2.0"]}},"required":["capabilityKey","capabilityVersion"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/warehouses":{"get":{"operationId":"listPublicAPIWarehouses","summary":"List warehouses","description":"Returns the warehouse directory. Active physical warehouses are included by default; includeArchived and includeDirectShip add those locations when needed. Continue a list with the returned cursor by itself, or read one warehouse by ID.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"warehouses:read","parameters":[{"schema":{"type":"string","minLength":1,"maxLength":160},"required":false,"name":"q","in":"query"},{"schema":{"type":"string","minLength":1,"maxLength":120},"required":false,"name":"externalId","in":"query"},{"schema":{"type":"string","enum":["true","false"]},"required":false,"name":"includeArchived","in":"query"},{"schema":{"type":"string","enum":["true","false"]},"required":false,"name":"includeDirectShip","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":10000,"default":10000},"required":false,"name":"limit","in":"query"},{"schema":{"type":"string"},"required":false,"name":"cursor","in":"query"}],"responses":{"200":{"description":"Warehouse directory and continuation details.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"street1":{"type":["string","null"]},"street2":{"type":["string","null"]},"city":{"type":["string","null"]},"country":{"type":["string","null"]},"state":{"type":["string","null"]},"zip":{"type":["string","null"]},"phone":{"type":["string","null"]},"email":{"type":["string","null"]},"contactName":{"type":["string","null"]},"externalId":{"type":["string","null"]},"directShip":{"type":"boolean"},"archivedAt":{"type":["string","null"],"format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","street1","street2","city","country","state","zip","phone","email","contactName","externalId","directShip","archivedAt","updatedAt"],"additionalProperties":false}},"meta":{"type":"object","properties":{"capabilityKey":{"type":"string","enum":["list_warehouses"]},"capabilityVersion":{"type":"string","enum":["1.0.0"]},"coverage":{"type":"object","properties":{"total":{"type":"integer"},"returned":{"type":"integer"},"complete":{"type":"boolean"}},"required":["total","returned","complete"]},"limit":{"type":"integer"},"nextCursor":{"type":["string","null"]}},"required":["capabilityKey","capabilityVersion","coverage","limit","nextCursor"]}},"required":["data","meta"]}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}},"post":{"operationId":"createPublicAPIWarehouse","summary":"Create a warehouse","description":"Creates a physical warehouse with its name, address, contact details, and optional unique source ID. Repeating the same source ID and fields returns the warehouse unchanged. When externalId is omitted, use Idempotency-Key for safe retries. Use dryRun=true to preview the request without saving it.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"warehouses:write","parameters":[{"schema":{"type":"string","enum":["true"]},"required":false,"name":"dryRun","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Required only when externalId is empty or omitted. dryRun may omit it and returns a blocked check."},"required":false,"description":"Required only when externalId is empty or omitted. dryRun may omit it and returns a blocked check.","name":"Idempotency-Key","in":"header"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"street1":{"type":["string","null"],"maxLength":500},"street2":{"type":["string","null"],"maxLength":500},"city":{"type":["string","null"],"maxLength":500},"country":{"type":["string","null"],"maxLength":500},"state":{"type":["string","null"],"maxLength":500},"zip":{"type":["string","null"],"maxLength":500},"phone":{"type":["string","null"],"maxLength":500},"email":{"type":["string","null"],"maxLength":320,"format":"email"},"contactName":{"type":["string","null"],"maxLength":500},"externalId":{"type":["string","null"],"maxLength":120}},"required":["name"],"additionalProperties":false}}}},"responses":{"200":{"description":"Existing option returned unchanged, or preview result.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"street1":{"type":["string","null"]},"street2":{"type":["string","null"]},"city":{"type":["string","null"]},"country":{"type":["string","null"]},"state":{"type":["string","null"]},"zip":{"type":["string","null"]},"phone":{"type":["string","null"]},"email":{"type":["string","null"]},"contactName":{"type":["string","null"]},"externalId":{"type":["string","null"]},"directShip":{"type":"boolean"},"archivedAt":{"type":["string","null"],"format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"changed":{"type":"boolean"}},"required":["id","name","street1","street2","city","country","state","zip","phone","email","contactName","externalId","directShip","archivedAt","updatedAt","changed"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["write_readiness"]},"operation":{"type":"string","enum":["warehouses.create","warehouses.update","warehouses.archive","warehouses.unarchive","shipping_options.create","shipping_options.update","shipping_options.archive","shipping_options.unarchive","reorder_points.create","tags.create","tags.update","tag_assignments.create","tag_assignments.delete","notes.create","notes.update","opportunities.create","opportunities.update","opportunities.close","opportunities.meta-upsert","contacts.create","contacts.update","customers.create","customers.update","customer_locations.create","customer_locations.update","customer_addresses.create","customer_addresses.update","suppliers.create","suppliers.update","supplier_ship_from_locations.create","supplier_ship_from_locations.update","products.create","products.update","products.archive","products.unarchive","product_packaging.create","products.suppliers.create","products.suppliers.delete","products.aliases.create","products.aliases.update","products.aliases.delete","product_families.aliases.create","product_families.aliases.update","product_families.aliases.delete","products.customer_part_numbers.create","products.customer_part_numbers.update","products.customer_part_numbers.delete","product_sds.update","product_documents.create","customer_documents.create","supplier_documents.create","purchase_order_documents.create","product_families.create","product_families.update","cost_book_entries.create","current_cost_sources.put","customers.archive","customers.unarchive","suppliers.archive","suppliers.unarchive","contacts.archive","contacts.unarchive","customer_addresses.archive","customer_addresses.unarchive","supplier_ship_from_locations.archive","supplier_ship_from_locations.unarchive","representatives.create","representatives.update","representatives.archive","representatives.unarchive","payment_terms.create","payment_terms.update","ledger_accounts.create","ledger_accounts.update"]},"status":{"type":"string","enum":["ready","blocked"]},"wouldWrite":{"type":"boolean","enum":[false]},"submit":{"type":"object","properties":{"method":{"type":"string","enum":["POST","PATCH","PUT","DELETE"]},"path":{"type":"string"},"query":{"type":"object","properties":{},"additionalProperties":false}},"required":["method","path","query"],"additionalProperties":false},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false},"checks":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["not_direct_ship","address_role_required","address_role_valid","already_assigned","already_exists","active_duplicate","ambiguous_external_id","ambiguous_natural_key","api_created","archived_target","archived_record","archive_blocked","account_type_locked","duplicate_candidate_found","duplicate_candidate_overflow","duplicate_check_clear","duplicate_check_not_needed","duplicate_contact","duplicate_customer","duplicate_customer_address","duplicate_customer_location","duplicate_note","duplicate_resolution_applied","duplicate_supplier","duplicate_supplier_ship_from_location","document_url_org_scoped","document_url_valid","upload_verified","sds_converged","idempotency_available","idempotency_key_required","idempotency_key_reused","idempotency_replay","idempotency_target_missing","income_statement_type_invalid","hard_identity_clear","nested_external_id_clear","commercial_references_valid","credit_denomination_mismatch","customer_service_representative_reference_active","ledger_account_reference_valid","payment_terms_reference_exists","sales_person_reference_active","supplier_representative_reference_active","duplicate_reference_identity","external_id_conflict","if_match_current","base_uom_transition_allowed","base_uom_transition_blocked","attribute_assignments_valid","attribute_assignments_invalid","selected_supplier_link","linked_records_available","natural_key_conflict","not_api_created","no_downstream_mutation","order_sensitive_update_allowed","order_sensitive_update_blocked","parent_available","cost_book_entry_blocked","cost_book_entry_valid","cost_book_reference_not_visible","unsupported_cost_book_uom","cost_uom_conversion_unavailable","cost_book_base_unavailable","cost_book_base_ambiguous","cost_ship_from_location_not_visible","cost_package_quantity_invalid","cost_component_invalid","cost_date_window_invalid","cost_date_overlap","cost_amount_overflow","cost_book_conflict","product_family_reference_active","product_packaging_reference_active","primary_child_available","primary_change_unsupported","reference_visibility_blocked","scope_authorized","stale_record","stale_cost_book_entry","supplier_reference_active","tag_applicable","tag_available","tag_exists","tag_found","tag_not_applicable","tag_not_found","type_immutable","type_known","type_required","target_active","target_available","target_not_found_or_not_visible","targets_visible","unsupported_linked_record","unsupported_profile_shape","variable_qty_valid","validation_failed","value_nonempty"]},"status":{"type":"string","enum":["passed","blocked"]},"message":{"type":"string"},"param":{"type":"string"}},"required":["code","status","message"],"additionalProperties":false}},"duplicateCandidates":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact","customer","supplier","customer_location","customer_address","supplier_ship_from_location","product","product_family","document"]},"readable":{"type":"boolean"},"version":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","product","purchase_order"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"matchReasons":{"type":"array","items":{"type":"string","enum":["name","email","externalId","address","code","product","url"]}},"readbackPath":{"type":"string"}},"required":["type","readable","matchReasons"],"additionalProperties":false}},"idempotency":{"type":"object","properties":{"required":{"type":"boolean"},"keyProvided":{"type":"boolean"},"wouldReplay":{"type":"boolean"}},"required":["required","keyProvided","wouldReplay"],"additionalProperties":false},"wouldChange":{"type":"object","properties":{"fieldNames":{"type":"array","items":{"type":"string"}},"values":{"type":"object","additionalProperties":{}}},"required":["fieldNames","values"],"additionalProperties":false},"impactAnalysis":{"type":"object","additionalProperties":{}},"requestId":{"type":"string"}},"required":["type","operation","status","wouldWrite","submit","verification","checks","duplicateCandidates","requestId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}]}}}},"201":{"description":"Created warehouse.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"street1":{"type":["string","null"]},"street2":{"type":["string","null"]},"city":{"type":["string","null"]},"country":{"type":["string","null"]},"state":{"type":["string","null"]},"zip":{"type":["string","null"]},"phone":{"type":["string","null"]},"email":{"type":["string","null"]},"contactName":{"type":["string","null"]},"externalId":{"type":["string","null"]},"directShip":{"type":"boolean"},"archivedAt":{"type":["string","null"],"format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"changed":{"type":"boolean"}},"required":["id","name","street1","street2","city","country","state","zip","phone","email","contactName","externalId","directShip","archivedAt","updatedAt","changed"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested parent or record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"409":{"description":"The write conflicted with an existing record, idempotency payload, or stale If-Match value.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/warehouses/{id}":{"get":{"operationId":"getPublicAPIWarehouse","summary":"Get a warehouse","description":"Returns the warehouse directory. Active physical warehouses are included by default; includeArchived and includeDirectShip add those locations when needed. Continue a list with the returned cursor by itself, or read one warehouse by ID.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"warehouses:read","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Warehouse details with the current updatedAt value.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"street1":{"type":["string","null"]},"street2":{"type":["string","null"]},"city":{"type":["string","null"]},"country":{"type":["string","null"]},"state":{"type":["string","null"]},"zip":{"type":["string","null"]},"phone":{"type":["string","null"]},"email":{"type":["string","null"]},"contactName":{"type":["string","null"]},"externalId":{"type":["string","null"]},"directShip":{"type":"boolean"},"archivedAt":{"type":["string","null"],"format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","street1","street2","city","country","state","zip","phone","email","contactName","externalId","directShip","archivedAt","updatedAt"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updatePublicAPIWarehouse","summary":"Update a warehouse","description":"Updates a physical warehouse's name, address, contact details, or source ID. Send the latest updatedAt value in If-Match, or use dryRun=true to preview the change.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"warehouses:write","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","enum":["true"]},"required":false,"name":"dryRun","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check."},"required":false,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check.","name":"If-Match","in":"header"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"street1":{"type":["string","null"],"maxLength":500},"street2":{"type":["string","null"],"maxLength":500},"city":{"type":["string","null"],"maxLength":500},"country":{"type":["string","null"],"maxLength":500},"state":{"type":["string","null"],"maxLength":500},"zip":{"type":["string","null"],"maxLength":500},"phone":{"type":["string","null"],"maxLength":500},"email":{"type":["string","null"],"maxLength":320,"format":"email"},"contactName":{"type":["string","null"],"maxLength":500},"externalId":{"type":["string","null"],"maxLength":120}},"additionalProperties":false}}}},"responses":{"200":{"description":"Updated warehouse, or preview result.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"street1":{"type":["string","null"]},"street2":{"type":["string","null"]},"city":{"type":["string","null"]},"country":{"type":["string","null"]},"state":{"type":["string","null"]},"zip":{"type":["string","null"]},"phone":{"type":["string","null"]},"email":{"type":["string","null"]},"contactName":{"type":["string","null"]},"externalId":{"type":["string","null"]},"directShip":{"type":"boolean"},"archivedAt":{"type":["string","null"],"format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"changed":{"type":"boolean"}},"required":["id","name","street1","street2","city","country","state","zip","phone","email","contactName","externalId","directShip","archivedAt","updatedAt","changed"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["write_readiness"]},"operation":{"type":"string","enum":["warehouses.create","warehouses.update","warehouses.archive","warehouses.unarchive","shipping_options.create","shipping_options.update","shipping_options.archive","shipping_options.unarchive","reorder_points.create","tags.create","tags.update","tag_assignments.create","tag_assignments.delete","notes.create","notes.update","opportunities.create","opportunities.update","opportunities.close","opportunities.meta-upsert","contacts.create","contacts.update","customers.create","customers.update","customer_locations.create","customer_locations.update","customer_addresses.create","customer_addresses.update","suppliers.create","suppliers.update","supplier_ship_from_locations.create","supplier_ship_from_locations.update","products.create","products.update","products.archive","products.unarchive","product_packaging.create","products.suppliers.create","products.suppliers.delete","products.aliases.create","products.aliases.update","products.aliases.delete","product_families.aliases.create","product_families.aliases.update","product_families.aliases.delete","products.customer_part_numbers.create","products.customer_part_numbers.update","products.customer_part_numbers.delete","product_sds.update","product_documents.create","customer_documents.create","supplier_documents.create","purchase_order_documents.create","product_families.create","product_families.update","cost_book_entries.create","current_cost_sources.put","customers.archive","customers.unarchive","suppliers.archive","suppliers.unarchive","contacts.archive","contacts.unarchive","customer_addresses.archive","customer_addresses.unarchive","supplier_ship_from_locations.archive","supplier_ship_from_locations.unarchive","representatives.create","representatives.update","representatives.archive","representatives.unarchive","payment_terms.create","payment_terms.update","ledger_accounts.create","ledger_accounts.update"]},"status":{"type":"string","enum":["ready","blocked"]},"wouldWrite":{"type":"boolean","enum":[false]},"submit":{"type":"object","properties":{"method":{"type":"string","enum":["POST","PATCH","PUT","DELETE"]},"path":{"type":"string"},"query":{"type":"object","properties":{},"additionalProperties":false}},"required":["method","path","query"],"additionalProperties":false},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false},"checks":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["not_direct_ship","address_role_required","address_role_valid","already_assigned","already_exists","active_duplicate","ambiguous_external_id","ambiguous_natural_key","api_created","archived_target","archived_record","archive_blocked","account_type_locked","duplicate_candidate_found","duplicate_candidate_overflow","duplicate_check_clear","duplicate_check_not_needed","duplicate_contact","duplicate_customer","duplicate_customer_address","duplicate_customer_location","duplicate_note","duplicate_resolution_applied","duplicate_supplier","duplicate_supplier_ship_from_location","document_url_org_scoped","document_url_valid","upload_verified","sds_converged","idempotency_available","idempotency_key_required","idempotency_key_reused","idempotency_replay","idempotency_target_missing","income_statement_type_invalid","hard_identity_clear","nested_external_id_clear","commercial_references_valid","credit_denomination_mismatch","customer_service_representative_reference_active","ledger_account_reference_valid","payment_terms_reference_exists","sales_person_reference_active","supplier_representative_reference_active","duplicate_reference_identity","external_id_conflict","if_match_current","base_uom_transition_allowed","base_uom_transition_blocked","attribute_assignments_valid","attribute_assignments_invalid","selected_supplier_link","linked_records_available","natural_key_conflict","not_api_created","no_downstream_mutation","order_sensitive_update_allowed","order_sensitive_update_blocked","parent_available","cost_book_entry_blocked","cost_book_entry_valid","cost_book_reference_not_visible","unsupported_cost_book_uom","cost_uom_conversion_unavailable","cost_book_base_unavailable","cost_book_base_ambiguous","cost_ship_from_location_not_visible","cost_package_quantity_invalid","cost_component_invalid","cost_date_window_invalid","cost_date_overlap","cost_amount_overflow","cost_book_conflict","product_family_reference_active","product_packaging_reference_active","primary_child_available","primary_change_unsupported","reference_visibility_blocked","scope_authorized","stale_record","stale_cost_book_entry","supplier_reference_active","tag_applicable","tag_available","tag_exists","tag_found","tag_not_applicable","tag_not_found","type_immutable","type_known","type_required","target_active","target_available","target_not_found_or_not_visible","targets_visible","unsupported_linked_record","unsupported_profile_shape","variable_qty_valid","validation_failed","value_nonempty"]},"status":{"type":"string","enum":["passed","blocked"]},"message":{"type":"string"},"param":{"type":"string"}},"required":["code","status","message"],"additionalProperties":false}},"duplicateCandidates":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact","customer","supplier","customer_location","customer_address","supplier_ship_from_location","product","product_family","document"]},"readable":{"type":"boolean"},"version":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","product","purchase_order"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"matchReasons":{"type":"array","items":{"type":"string","enum":["name","email","externalId","address","code","product","url"]}},"readbackPath":{"type":"string"}},"required":["type","readable","matchReasons"],"additionalProperties":false}},"idempotency":{"type":"object","properties":{"required":{"type":"boolean"},"keyProvided":{"type":"boolean"},"wouldReplay":{"type":"boolean"}},"required":["required","keyProvided","wouldReplay"],"additionalProperties":false},"wouldChange":{"type":"object","properties":{"fieldNames":{"type":"array","items":{"type":"string"}},"values":{"type":"object","additionalProperties":{}}},"required":["fieldNames","values"],"additionalProperties":false},"impactAnalysis":{"type":"object","additionalProperties":{}},"requestId":{"type":"string"}},"required":["type","operation","status","wouldWrite","submit","verification","checks","duplicateCandidates","requestId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}]}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested parent or record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"409":{"description":"The write conflicted with an existing record, idempotency payload, or stale If-Match value.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/warehouses/{id}/archive":{"post":{"operationId":"archivePublicAPIWarehouse","summary":"Archive a warehouse","description":"Archives or restores a physical warehouse while preserving its identity and existing inventory history. Send an empty body with the latest updatedAt value in If-Match, or use dryRun=true to preview the action.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"warehouses:write","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","enum":["true"]},"required":false,"name":"dryRun","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check."},"required":false,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check.","name":"If-Match","in":"header"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false}}}},"responses":{"200":{"description":"Lifecycle receipt or readiness.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["lifecycle_receipt"]},"resource":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","customer_contact","supplier_contact","customer_address","supplier_ship_from_location","representative","product","warehouse","shipping_option"]},"kind":{"type":"string","enum":["salesperson","customer_service","supplier"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},"action":{"type":"string","enum":["archive","unarchive"]},"archived":{"type":"boolean"},"changed":{"type":"boolean"},"updatedAt":{"type":"string","format":"date-time"},"requestId":{"type":"string"},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false}},"required":["type","resource","action","archived","changed","updatedAt","requestId","verification"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["write_readiness"]},"operation":{"type":"string","enum":["warehouses.create","warehouses.update","warehouses.archive","warehouses.unarchive","shipping_options.create","shipping_options.update","shipping_options.archive","shipping_options.unarchive","reorder_points.create","tags.create","tags.update","tag_assignments.create","tag_assignments.delete","notes.create","notes.update","opportunities.create","opportunities.update","opportunities.close","opportunities.meta-upsert","contacts.create","contacts.update","customers.create","customers.update","customer_locations.create","customer_locations.update","customer_addresses.create","customer_addresses.update","suppliers.create","suppliers.update","supplier_ship_from_locations.create","supplier_ship_from_locations.update","products.create","products.update","products.archive","products.unarchive","product_packaging.create","products.suppliers.create","products.suppliers.delete","products.aliases.create","products.aliases.update","products.aliases.delete","product_families.aliases.create","product_families.aliases.update","product_families.aliases.delete","products.customer_part_numbers.create","products.customer_part_numbers.update","products.customer_part_numbers.delete","product_sds.update","product_documents.create","customer_documents.create","supplier_documents.create","purchase_order_documents.create","product_families.create","product_families.update","cost_book_entries.create","current_cost_sources.put","customers.archive","customers.unarchive","suppliers.archive","suppliers.unarchive","contacts.archive","contacts.unarchive","customer_addresses.archive","customer_addresses.unarchive","supplier_ship_from_locations.archive","supplier_ship_from_locations.unarchive","representatives.create","representatives.update","representatives.archive","representatives.unarchive","payment_terms.create","payment_terms.update","ledger_accounts.create","ledger_accounts.update"]},"status":{"type":"string","enum":["ready","blocked"]},"wouldWrite":{"type":"boolean","enum":[false]},"submit":{"type":"object","properties":{"method":{"type":"string","enum":["POST","PATCH","PUT","DELETE"]},"path":{"type":"string"},"query":{"type":"object","properties":{},"additionalProperties":false}},"required":["method","path","query"],"additionalProperties":false},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false},"checks":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["not_direct_ship","address_role_required","address_role_valid","already_assigned","already_exists","active_duplicate","ambiguous_external_id","ambiguous_natural_key","api_created","archived_target","archived_record","archive_blocked","account_type_locked","duplicate_candidate_found","duplicate_candidate_overflow","duplicate_check_clear","duplicate_check_not_needed","duplicate_contact","duplicate_customer","duplicate_customer_address","duplicate_customer_location","duplicate_note","duplicate_resolution_applied","duplicate_supplier","duplicate_supplier_ship_from_location","document_url_org_scoped","document_url_valid","upload_verified","sds_converged","idempotency_available","idempotency_key_required","idempotency_key_reused","idempotency_replay","idempotency_target_missing","income_statement_type_invalid","hard_identity_clear","nested_external_id_clear","commercial_references_valid","credit_denomination_mismatch","customer_service_representative_reference_active","ledger_account_reference_valid","payment_terms_reference_exists","sales_person_reference_active","supplier_representative_reference_active","duplicate_reference_identity","external_id_conflict","if_match_current","base_uom_transition_allowed","base_uom_transition_blocked","attribute_assignments_valid","attribute_assignments_invalid","selected_supplier_link","linked_records_available","natural_key_conflict","not_api_created","no_downstream_mutation","order_sensitive_update_allowed","order_sensitive_update_blocked","parent_available","cost_book_entry_blocked","cost_book_entry_valid","cost_book_reference_not_visible","unsupported_cost_book_uom","cost_uom_conversion_unavailable","cost_book_base_unavailable","cost_book_base_ambiguous","cost_ship_from_location_not_visible","cost_package_quantity_invalid","cost_component_invalid","cost_date_window_invalid","cost_date_overlap","cost_amount_overflow","cost_book_conflict","product_family_reference_active","product_packaging_reference_active","primary_child_available","primary_change_unsupported","reference_visibility_blocked","scope_authorized","stale_record","stale_cost_book_entry","supplier_reference_active","tag_applicable","tag_available","tag_exists","tag_found","tag_not_applicable","tag_not_found","type_immutable","type_known","type_required","target_active","target_available","target_not_found_or_not_visible","targets_visible","unsupported_linked_record","unsupported_profile_shape","variable_qty_valid","validation_failed","value_nonempty"]},"status":{"type":"string","enum":["passed","blocked"]},"message":{"type":"string"},"param":{"type":"string"}},"required":["code","status","message"],"additionalProperties":false}},"duplicateCandidates":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact","customer","supplier","customer_location","customer_address","supplier_ship_from_location","product","product_family","document"]},"readable":{"type":"boolean"},"version":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","product","purchase_order"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"matchReasons":{"type":"array","items":{"type":"string","enum":["name","email","externalId","address","code","product","url"]}},"readbackPath":{"type":"string"}},"required":["type","readable","matchReasons"],"additionalProperties":false}},"idempotency":{"type":"object","properties":{"required":{"type":"boolean"},"keyProvided":{"type":"boolean"},"wouldReplay":{"type":"boolean"}},"required":["required","keyProvided","wouldReplay"],"additionalProperties":false},"wouldChange":{"type":"object","properties":{"fieldNames":{"type":"array","items":{"type":"string"}},"values":{"type":"object","additionalProperties":{}}},"required":["fieldNames","values"],"additionalProperties":false},"impactAnalysis":{"type":"object","additionalProperties":{}},"requestId":{"type":"string"}},"required":["type","operation","status","wouldWrite","submit","verification","checks","duplicateCandidates","requestId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}]}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested parent or record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"409":{"description":"The write conflicted with an existing record, idempotency payload, or stale If-Match value.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/warehouses/{id}/unarchive":{"post":{"operationId":"unarchivePublicAPIWarehouse","summary":"Restore a warehouse","description":"Archives or restores a physical warehouse while preserving its identity and existing inventory history. Send an empty body with the latest updatedAt value in If-Match, or use dryRun=true to preview the action.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"warehouses:write","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","enum":["true"]},"required":false,"name":"dryRun","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check."},"required":false,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check.","name":"If-Match","in":"header"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false}}}},"responses":{"200":{"description":"Lifecycle receipt or readiness.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["lifecycle_receipt"]},"resource":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","customer_contact","supplier_contact","customer_address","supplier_ship_from_location","representative","product","warehouse","shipping_option"]},"kind":{"type":"string","enum":["salesperson","customer_service","supplier"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},"action":{"type":"string","enum":["archive","unarchive"]},"archived":{"type":"boolean"},"changed":{"type":"boolean"},"updatedAt":{"type":"string","format":"date-time"},"requestId":{"type":"string"},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false}},"required":["type","resource","action","archived","changed","updatedAt","requestId","verification"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["write_readiness"]},"operation":{"type":"string","enum":["warehouses.create","warehouses.update","warehouses.archive","warehouses.unarchive","shipping_options.create","shipping_options.update","shipping_options.archive","shipping_options.unarchive","reorder_points.create","tags.create","tags.update","tag_assignments.create","tag_assignments.delete","notes.create","notes.update","opportunities.create","opportunities.update","opportunities.close","opportunities.meta-upsert","contacts.create","contacts.update","customers.create","customers.update","customer_locations.create","customer_locations.update","customer_addresses.create","customer_addresses.update","suppliers.create","suppliers.update","supplier_ship_from_locations.create","supplier_ship_from_locations.update","products.create","products.update","products.archive","products.unarchive","product_packaging.create","products.suppliers.create","products.suppliers.delete","products.aliases.create","products.aliases.update","products.aliases.delete","product_families.aliases.create","product_families.aliases.update","product_families.aliases.delete","products.customer_part_numbers.create","products.customer_part_numbers.update","products.customer_part_numbers.delete","product_sds.update","product_documents.create","customer_documents.create","supplier_documents.create","purchase_order_documents.create","product_families.create","product_families.update","cost_book_entries.create","current_cost_sources.put","customers.archive","customers.unarchive","suppliers.archive","suppliers.unarchive","contacts.archive","contacts.unarchive","customer_addresses.archive","customer_addresses.unarchive","supplier_ship_from_locations.archive","supplier_ship_from_locations.unarchive","representatives.create","representatives.update","representatives.archive","representatives.unarchive","payment_terms.create","payment_terms.update","ledger_accounts.create","ledger_accounts.update"]},"status":{"type":"string","enum":["ready","blocked"]},"wouldWrite":{"type":"boolean","enum":[false]},"submit":{"type":"object","properties":{"method":{"type":"string","enum":["POST","PATCH","PUT","DELETE"]},"path":{"type":"string"},"query":{"type":"object","properties":{},"additionalProperties":false}},"required":["method","path","query"],"additionalProperties":false},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false},"checks":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["not_direct_ship","address_role_required","address_role_valid","already_assigned","already_exists","active_duplicate","ambiguous_external_id","ambiguous_natural_key","api_created","archived_target","archived_record","archive_blocked","account_type_locked","duplicate_candidate_found","duplicate_candidate_overflow","duplicate_check_clear","duplicate_check_not_needed","duplicate_contact","duplicate_customer","duplicate_customer_address","duplicate_customer_location","duplicate_note","duplicate_resolution_applied","duplicate_supplier","duplicate_supplier_ship_from_location","document_url_org_scoped","document_url_valid","upload_verified","sds_converged","idempotency_available","idempotency_key_required","idempotency_key_reused","idempotency_replay","idempotency_target_missing","income_statement_type_invalid","hard_identity_clear","nested_external_id_clear","commercial_references_valid","credit_denomination_mismatch","customer_service_representative_reference_active","ledger_account_reference_valid","payment_terms_reference_exists","sales_person_reference_active","supplier_representative_reference_active","duplicate_reference_identity","external_id_conflict","if_match_current","base_uom_transition_allowed","base_uom_transition_blocked","attribute_assignments_valid","attribute_assignments_invalid","selected_supplier_link","linked_records_available","natural_key_conflict","not_api_created","no_downstream_mutation","order_sensitive_update_allowed","order_sensitive_update_blocked","parent_available","cost_book_entry_blocked","cost_book_entry_valid","cost_book_reference_not_visible","unsupported_cost_book_uom","cost_uom_conversion_unavailable","cost_book_base_unavailable","cost_book_base_ambiguous","cost_ship_from_location_not_visible","cost_package_quantity_invalid","cost_component_invalid","cost_date_window_invalid","cost_date_overlap","cost_amount_overflow","cost_book_conflict","product_family_reference_active","product_packaging_reference_active","primary_child_available","primary_change_unsupported","reference_visibility_blocked","scope_authorized","stale_record","stale_cost_book_entry","supplier_reference_active","tag_applicable","tag_available","tag_exists","tag_found","tag_not_applicable","tag_not_found","type_immutable","type_known","type_required","target_active","target_available","target_not_found_or_not_visible","targets_visible","unsupported_linked_record","unsupported_profile_shape","variable_qty_valid","validation_failed","value_nonempty"]},"status":{"type":"string","enum":["passed","blocked"]},"message":{"type":"string"},"param":{"type":"string"}},"required":["code","status","message"],"additionalProperties":false}},"duplicateCandidates":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact","customer","supplier","customer_location","customer_address","supplier_ship_from_location","product","product_family","document"]},"readable":{"type":"boolean"},"version":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","product","purchase_order"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"matchReasons":{"type":"array","items":{"type":"string","enum":["name","email","externalId","address","code","product","url"]}},"readbackPath":{"type":"string"}},"required":["type","readable","matchReasons"],"additionalProperties":false}},"idempotency":{"type":"object","properties":{"required":{"type":"boolean"},"keyProvided":{"type":"boolean"},"wouldReplay":{"type":"boolean"}},"required":["required","keyProvided","wouldReplay"],"additionalProperties":false},"wouldChange":{"type":"object","properties":{"fieldNames":{"type":"array","items":{"type":"string"}},"values":{"type":"object","additionalProperties":{}}},"required":["fieldNames","values"],"additionalProperties":false},"impactAnalysis":{"type":"object","additionalProperties":{}},"requestId":{"type":"string"}},"required":["type","operation","status","wouldWrite","submit","verification","checks","duplicateCandidates","requestId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}]}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested parent or record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"409":{"description":"The write conflicted with an existing record, idempotency payload, or stale If-Match value.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/shipping-options":{"get":{"operationId":"listPublicAPIShippingOptions","summary":"List shipping options","description":"Returns the organization's Shipping Options vocabulary across sales and purchase freight terms, sales shipping carriers, FOB terms, freight methods, and border crossing points. Use type to select one vocabulary, includeArchived to review retired choices, or read one option by ID. Archiving preserves the option's identity and existing document history.","tags":["Shipping Options"],"security":[{"bearerAuth":[]}],"x-required-scope":"shipping-options:read","parameters":[{"schema":{"type":"string","enum":["SO_FREIGHT_TERMS","PO_FREIGHT_TERMS","SO_SHIPPING_CARRIER","SO_SHIPPING_FOB","SO_FREIGHT_METHOD","BORDER_CROSSING_POINT"]},"required":false,"name":"type","in":"query"},{"schema":{"type":"string","minLength":1,"maxLength":160},"required":false,"name":"q","in":"query"},{"schema":{"type":"string","minLength":1,"maxLength":120},"required":false,"name":"externalId","in":"query"},{"schema":{"type":"string","enum":["true","false"]},"required":false,"name":"includeArchived","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":10000,"default":10000},"required":false,"name":"limit","in":"query"}],"responses":{"200":{"description":"Shipping Options directory and complete result coverage.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["SO_FREIGHT_TERMS","PO_FREIGHT_TERMS","SO_SHIPPING_CARRIER","SO_SHIPPING_FOB","SO_FREIGHT_METHOD","BORDER_CROSSING_POINT"]},"value":{"type":"string"},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","type","value","externalId","archivedAt","updatedAt"],"additionalProperties":false}},"meta":{"type":"object","properties":{"capabilityKey":{"type":"string","enum":["list_shipping_options"]},"capabilityVersion":{"type":"string","enum":["1.0.0"]},"coverage":{"type":"object","properties":{"total":{"type":"integer"},"returned":{"type":"integer"},"complete":{"type":"boolean"}},"required":["total","returned","complete"]},"limit":{"type":"integer"}},"required":["capabilityKey","capabilityVersion","coverage","limit"]}},"required":["data","meta"]}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}},"post":{"operationId":"createPublicAPIShippingOption","summary":"Create a shipping option","description":"Creates one Shipping Option with its type, value, and optional source ID. Source identity belongs to the selected type. Repeating the same source identity or type and value returns the existing option unchanged when it matches. Use Idempotency-Key for a new option, or dryRun=true to preview the request.","tags":["Shipping Options"],"security":[{"bearerAuth":[]}],"x-required-scope":"shipping-options:write","parameters":[{"schema":{"type":"string","enum":["true"]},"required":false,"name":"dryRun","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Required when no externalId or natural-key match exists. dryRun may omit it and returns a blocked check."},"required":false,"description":"Required when no externalId or natural-key match exists. dryRun may omit it and returns a blocked check.","name":"Idempotency-Key","in":"header"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["SO_FREIGHT_TERMS","PO_FREIGHT_TERMS","SO_SHIPPING_CARRIER","SO_SHIPPING_FOB","SO_FREIGHT_METHOD","BORDER_CROSSING_POINT"]},"value":{"type":"string","minLength":1},"externalId":{"type":["string","null"],"maxLength":120}},"required":["type","value"],"additionalProperties":false}}}},"responses":{"200":{"description":"Existing option returned unchanged, or preview result.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["SO_FREIGHT_TERMS","PO_FREIGHT_TERMS","SO_SHIPPING_CARRIER","SO_SHIPPING_FOB","SO_FREIGHT_METHOD","BORDER_CROSSING_POINT"]},"value":{"type":"string"},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"changed":{"type":"boolean"}},"required":["id","type","value","externalId","archivedAt","updatedAt","changed"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["write_readiness"]},"operation":{"type":"string","enum":["warehouses.create","warehouses.update","warehouses.archive","warehouses.unarchive","shipping_options.create","shipping_options.update","shipping_options.archive","shipping_options.unarchive","reorder_points.create","tags.create","tags.update","tag_assignments.create","tag_assignments.delete","notes.create","notes.update","opportunities.create","opportunities.update","opportunities.close","opportunities.meta-upsert","contacts.create","contacts.update","customers.create","customers.update","customer_locations.create","customer_locations.update","customer_addresses.create","customer_addresses.update","suppliers.create","suppliers.update","supplier_ship_from_locations.create","supplier_ship_from_locations.update","products.create","products.update","products.archive","products.unarchive","product_packaging.create","products.suppliers.create","products.suppliers.delete","products.aliases.create","products.aliases.update","products.aliases.delete","product_families.aliases.create","product_families.aliases.update","product_families.aliases.delete","products.customer_part_numbers.create","products.customer_part_numbers.update","products.customer_part_numbers.delete","product_sds.update","product_documents.create","customer_documents.create","supplier_documents.create","purchase_order_documents.create","product_families.create","product_families.update","cost_book_entries.create","current_cost_sources.put","customers.archive","customers.unarchive","suppliers.archive","suppliers.unarchive","contacts.archive","contacts.unarchive","customer_addresses.archive","customer_addresses.unarchive","supplier_ship_from_locations.archive","supplier_ship_from_locations.unarchive","representatives.create","representatives.update","representatives.archive","representatives.unarchive","payment_terms.create","payment_terms.update","ledger_accounts.create","ledger_accounts.update"]},"status":{"type":"string","enum":["ready","blocked"]},"wouldWrite":{"type":"boolean","enum":[false]},"submit":{"type":"object","properties":{"method":{"type":"string","enum":["POST","PATCH","PUT","DELETE"]},"path":{"type":"string"},"query":{"type":"object","properties":{},"additionalProperties":false}},"required":["method","path","query"],"additionalProperties":false},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false},"checks":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["not_direct_ship","address_role_required","address_role_valid","already_assigned","already_exists","active_duplicate","ambiguous_external_id","ambiguous_natural_key","api_created","archived_target","archived_record","archive_blocked","account_type_locked","duplicate_candidate_found","duplicate_candidate_overflow","duplicate_check_clear","duplicate_check_not_needed","duplicate_contact","duplicate_customer","duplicate_customer_address","duplicate_customer_location","duplicate_note","duplicate_resolution_applied","duplicate_supplier","duplicate_supplier_ship_from_location","document_url_org_scoped","document_url_valid","upload_verified","sds_converged","idempotency_available","idempotency_key_required","idempotency_key_reused","idempotency_replay","idempotency_target_missing","income_statement_type_invalid","hard_identity_clear","nested_external_id_clear","commercial_references_valid","credit_denomination_mismatch","customer_service_representative_reference_active","ledger_account_reference_valid","payment_terms_reference_exists","sales_person_reference_active","supplier_representative_reference_active","duplicate_reference_identity","external_id_conflict","if_match_current","base_uom_transition_allowed","base_uom_transition_blocked","attribute_assignments_valid","attribute_assignments_invalid","selected_supplier_link","linked_records_available","natural_key_conflict","not_api_created","no_downstream_mutation","order_sensitive_update_allowed","order_sensitive_update_blocked","parent_available","cost_book_entry_blocked","cost_book_entry_valid","cost_book_reference_not_visible","unsupported_cost_book_uom","cost_uom_conversion_unavailable","cost_book_base_unavailable","cost_book_base_ambiguous","cost_ship_from_location_not_visible","cost_package_quantity_invalid","cost_component_invalid","cost_date_window_invalid","cost_date_overlap","cost_amount_overflow","cost_book_conflict","product_family_reference_active","product_packaging_reference_active","primary_child_available","primary_change_unsupported","reference_visibility_blocked","scope_authorized","stale_record","stale_cost_book_entry","supplier_reference_active","tag_applicable","tag_available","tag_exists","tag_found","tag_not_applicable","tag_not_found","type_immutable","type_known","type_required","target_active","target_available","target_not_found_or_not_visible","targets_visible","unsupported_linked_record","unsupported_profile_shape","variable_qty_valid","validation_failed","value_nonempty"]},"status":{"type":"string","enum":["passed","blocked"]},"message":{"type":"string"},"param":{"type":"string"}},"required":["code","status","message"],"additionalProperties":false}},"duplicateCandidates":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact","customer","supplier","customer_location","customer_address","supplier_ship_from_location","product","product_family","document"]},"readable":{"type":"boolean"},"version":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","product","purchase_order"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"matchReasons":{"type":"array","items":{"type":"string","enum":["name","email","externalId","address","code","product","url"]}},"readbackPath":{"type":"string"}},"required":["type","readable","matchReasons"],"additionalProperties":false}},"idempotency":{"type":"object","properties":{"required":{"type":"boolean"},"keyProvided":{"type":"boolean"},"wouldReplay":{"type":"boolean"}},"required":["required","keyProvided","wouldReplay"],"additionalProperties":false},"wouldChange":{"type":"object","properties":{"fieldNames":{"type":"array","items":{"type":"string"}},"values":{"type":"object","additionalProperties":{}}},"required":["fieldNames","values"],"additionalProperties":false},"impactAnalysis":{"type":"object","additionalProperties":{}},"requestId":{"type":"string"}},"required":["type","operation","status","wouldWrite","submit","verification","checks","duplicateCandidates","requestId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}]}}}},"201":{"description":"Created Shipping Option.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["SO_FREIGHT_TERMS","PO_FREIGHT_TERMS","SO_SHIPPING_CARRIER","SO_SHIPPING_FOB","SO_FREIGHT_METHOD","BORDER_CROSSING_POINT"]},"value":{"type":"string"},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"changed":{"type":"boolean"}},"required":["id","type","value","externalId","archivedAt","updatedAt","changed"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested parent or record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"409":{"description":"The write conflicted with an existing record, idempotency payload, or stale If-Match value.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/shipping-options/{id}":{"get":{"operationId":"getPublicAPIShippingOption","summary":"Read shipping option identity","description":"Returns the organization's Shipping Options vocabulary across sales and purchase freight terms, sales shipping carriers, FOB terms, freight methods, and border crossing points. Use type to select one vocabulary, includeArchived to review retired choices, or read one option by ID. Archiving preserves the option's identity and existing document history.","tags":["Shipping Options"],"security":[{"bearerAuth":[]}],"x-required-scope":"shipping-options:read","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Shipping Option details with the current updatedAt value.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["SO_FREIGHT_TERMS","PO_FREIGHT_TERMS","SO_SHIPPING_CARRIER","SO_SHIPPING_FOB","SO_FREIGHT_METHOD","BORDER_CROSSING_POINT"]},"value":{"type":"string"},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","type","value","externalId","archivedAt","updatedAt"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updatePublicAPIShippingOption","summary":"Update a shipping option","description":"Updates one Shipping Option's value or source ID. Send the latest updatedAt value in If-Match, or use dryRun=true to preview the change. Restore an archived option before updating it; the option type remains fixed.","tags":["Shipping Options"],"security":[{"bearerAuth":[]}],"x-required-scope":"shipping-options:write","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","enum":["true"]},"required":false,"name":"dryRun","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check."},"required":false,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check.","name":"If-Match","in":"header"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"value":{"type":"string","minLength":1},"externalId":{"type":["string","null"],"maxLength":120}},"additionalProperties":false}}}},"responses":{"200":{"description":"Updated Shipping Option, or preview result.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["SO_FREIGHT_TERMS","PO_FREIGHT_TERMS","SO_SHIPPING_CARRIER","SO_SHIPPING_FOB","SO_FREIGHT_METHOD","BORDER_CROSSING_POINT"]},"value":{"type":"string"},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"changed":{"type":"boolean"}},"required":["id","type","value","externalId","archivedAt","updatedAt","changed"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["write_readiness"]},"operation":{"type":"string","enum":["warehouses.create","warehouses.update","warehouses.archive","warehouses.unarchive","shipping_options.create","shipping_options.update","shipping_options.archive","shipping_options.unarchive","reorder_points.create","tags.create","tags.update","tag_assignments.create","tag_assignments.delete","notes.create","notes.update","opportunities.create","opportunities.update","opportunities.close","opportunities.meta-upsert","contacts.create","contacts.update","customers.create","customers.update","customer_locations.create","customer_locations.update","customer_addresses.create","customer_addresses.update","suppliers.create","suppliers.update","supplier_ship_from_locations.create","supplier_ship_from_locations.update","products.create","products.update","products.archive","products.unarchive","product_packaging.create","products.suppliers.create","products.suppliers.delete","products.aliases.create","products.aliases.update","products.aliases.delete","product_families.aliases.create","product_families.aliases.update","product_families.aliases.delete","products.customer_part_numbers.create","products.customer_part_numbers.update","products.customer_part_numbers.delete","product_sds.update","product_documents.create","customer_documents.create","supplier_documents.create","purchase_order_documents.create","product_families.create","product_families.update","cost_book_entries.create","current_cost_sources.put","customers.archive","customers.unarchive","suppliers.archive","suppliers.unarchive","contacts.archive","contacts.unarchive","customer_addresses.archive","customer_addresses.unarchive","supplier_ship_from_locations.archive","supplier_ship_from_locations.unarchive","representatives.create","representatives.update","representatives.archive","representatives.unarchive","payment_terms.create","payment_terms.update","ledger_accounts.create","ledger_accounts.update"]},"status":{"type":"string","enum":["ready","blocked"]},"wouldWrite":{"type":"boolean","enum":[false]},"submit":{"type":"object","properties":{"method":{"type":"string","enum":["POST","PATCH","PUT","DELETE"]},"path":{"type":"string"},"query":{"type":"object","properties":{},"additionalProperties":false}},"required":["method","path","query"],"additionalProperties":false},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false},"checks":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["not_direct_ship","address_role_required","address_role_valid","already_assigned","already_exists","active_duplicate","ambiguous_external_id","ambiguous_natural_key","api_created","archived_target","archived_record","archive_blocked","account_type_locked","duplicate_candidate_found","duplicate_candidate_overflow","duplicate_check_clear","duplicate_check_not_needed","duplicate_contact","duplicate_customer","duplicate_customer_address","duplicate_customer_location","duplicate_note","duplicate_resolution_applied","duplicate_supplier","duplicate_supplier_ship_from_location","document_url_org_scoped","document_url_valid","upload_verified","sds_converged","idempotency_available","idempotency_key_required","idempotency_key_reused","idempotency_replay","idempotency_target_missing","income_statement_type_invalid","hard_identity_clear","nested_external_id_clear","commercial_references_valid","credit_denomination_mismatch","customer_service_representative_reference_active","ledger_account_reference_valid","payment_terms_reference_exists","sales_person_reference_active","supplier_representative_reference_active","duplicate_reference_identity","external_id_conflict","if_match_current","base_uom_transition_allowed","base_uom_transition_blocked","attribute_assignments_valid","attribute_assignments_invalid","selected_supplier_link","linked_records_available","natural_key_conflict","not_api_created","no_downstream_mutation","order_sensitive_update_allowed","order_sensitive_update_blocked","parent_available","cost_book_entry_blocked","cost_book_entry_valid","cost_book_reference_not_visible","unsupported_cost_book_uom","cost_uom_conversion_unavailable","cost_book_base_unavailable","cost_book_base_ambiguous","cost_ship_from_location_not_visible","cost_package_quantity_invalid","cost_component_invalid","cost_date_window_invalid","cost_date_overlap","cost_amount_overflow","cost_book_conflict","product_family_reference_active","product_packaging_reference_active","primary_child_available","primary_change_unsupported","reference_visibility_blocked","scope_authorized","stale_record","stale_cost_book_entry","supplier_reference_active","tag_applicable","tag_available","tag_exists","tag_found","tag_not_applicable","tag_not_found","type_immutable","type_known","type_required","target_active","target_available","target_not_found_or_not_visible","targets_visible","unsupported_linked_record","unsupported_profile_shape","variable_qty_valid","validation_failed","value_nonempty"]},"status":{"type":"string","enum":["passed","blocked"]},"message":{"type":"string"},"param":{"type":"string"}},"required":["code","status","message"],"additionalProperties":false}},"duplicateCandidates":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact","customer","supplier","customer_location","customer_address","supplier_ship_from_location","product","product_family","document"]},"readable":{"type":"boolean"},"version":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","product","purchase_order"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"matchReasons":{"type":"array","items":{"type":"string","enum":["name","email","externalId","address","code","product","url"]}},"readbackPath":{"type":"string"}},"required":["type","readable","matchReasons"],"additionalProperties":false}},"idempotency":{"type":"object","properties":{"required":{"type":"boolean"},"keyProvided":{"type":"boolean"},"wouldReplay":{"type":"boolean"}},"required":["required","keyProvided","wouldReplay"],"additionalProperties":false},"wouldChange":{"type":"object","properties":{"fieldNames":{"type":"array","items":{"type":"string"}},"values":{"type":"object","additionalProperties":{}}},"required":["fieldNames","values"],"additionalProperties":false},"impactAnalysis":{"type":"object","additionalProperties":{}},"requestId":{"type":"string"}},"required":["type","operation","status","wouldWrite","submit","verification","checks","duplicateCandidates","requestId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}]}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested parent or record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"409":{"description":"The write conflicted with an existing record, idempotency payload, or stale If-Match value.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/shipping-options/{id}/archive":{"post":{"operationId":"archivePublicAPIShippingOption","summary":"archive shipping option","description":"Archives or restores one Shipping Option while preserving its identity. Send an empty body with the latest updatedAt value in If-Match, or use dryRun=true to preview the action.","tags":["Shipping Options"],"security":[{"bearerAuth":[]}],"x-required-scope":"shipping-options:write","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","enum":["true"]},"required":false,"name":"dryRun","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check."},"required":false,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check.","name":"If-Match","in":"header"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false}}}},"responses":{"200":{"description":"Lifecycle receipt or readiness.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["lifecycle_receipt"]},"resource":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","customer_contact","supplier_contact","customer_address","supplier_ship_from_location","representative","product","warehouse","shipping_option"]},"kind":{"type":"string","enum":["salesperson","customer_service","supplier"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},"action":{"type":"string","enum":["archive","unarchive"]},"archived":{"type":"boolean"},"changed":{"type":"boolean"},"updatedAt":{"type":"string","format":"date-time"},"requestId":{"type":"string"},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false}},"required":["type","resource","action","archived","changed","updatedAt","requestId","verification"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["write_readiness"]},"operation":{"type":"string","enum":["warehouses.create","warehouses.update","warehouses.archive","warehouses.unarchive","shipping_options.create","shipping_options.update","shipping_options.archive","shipping_options.unarchive","reorder_points.create","tags.create","tags.update","tag_assignments.create","tag_assignments.delete","notes.create","notes.update","opportunities.create","opportunities.update","opportunities.close","opportunities.meta-upsert","contacts.create","contacts.update","customers.create","customers.update","customer_locations.create","customer_locations.update","customer_addresses.create","customer_addresses.update","suppliers.create","suppliers.update","supplier_ship_from_locations.create","supplier_ship_from_locations.update","products.create","products.update","products.archive","products.unarchive","product_packaging.create","products.suppliers.create","products.suppliers.delete","products.aliases.create","products.aliases.update","products.aliases.delete","product_families.aliases.create","product_families.aliases.update","product_families.aliases.delete","products.customer_part_numbers.create","products.customer_part_numbers.update","products.customer_part_numbers.delete","product_sds.update","product_documents.create","customer_documents.create","supplier_documents.create","purchase_order_documents.create","product_families.create","product_families.update","cost_book_entries.create","current_cost_sources.put","customers.archive","customers.unarchive","suppliers.archive","suppliers.unarchive","contacts.archive","contacts.unarchive","customer_addresses.archive","customer_addresses.unarchive","supplier_ship_from_locations.archive","supplier_ship_from_locations.unarchive","representatives.create","representatives.update","representatives.archive","representatives.unarchive","payment_terms.create","payment_terms.update","ledger_accounts.create","ledger_accounts.update"]},"status":{"type":"string","enum":["ready","blocked"]},"wouldWrite":{"type":"boolean","enum":[false]},"submit":{"type":"object","properties":{"method":{"type":"string","enum":["POST","PATCH","PUT","DELETE"]},"path":{"type":"string"},"query":{"type":"object","properties":{},"additionalProperties":false}},"required":["method","path","query"],"additionalProperties":false},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false},"checks":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["not_direct_ship","address_role_required","address_role_valid","already_assigned","already_exists","active_duplicate","ambiguous_external_id","ambiguous_natural_key","api_created","archived_target","archived_record","archive_blocked","account_type_locked","duplicate_candidate_found","duplicate_candidate_overflow","duplicate_check_clear","duplicate_check_not_needed","duplicate_contact","duplicate_customer","duplicate_customer_address","duplicate_customer_location","duplicate_note","duplicate_resolution_applied","duplicate_supplier","duplicate_supplier_ship_from_location","document_url_org_scoped","document_url_valid","upload_verified","sds_converged","idempotency_available","idempotency_key_required","idempotency_key_reused","idempotency_replay","idempotency_target_missing","income_statement_type_invalid","hard_identity_clear","nested_external_id_clear","commercial_references_valid","credit_denomination_mismatch","customer_service_representative_reference_active","ledger_account_reference_valid","payment_terms_reference_exists","sales_person_reference_active","supplier_representative_reference_active","duplicate_reference_identity","external_id_conflict","if_match_current","base_uom_transition_allowed","base_uom_transition_blocked","attribute_assignments_valid","attribute_assignments_invalid","selected_supplier_link","linked_records_available","natural_key_conflict","not_api_created","no_downstream_mutation","order_sensitive_update_allowed","order_sensitive_update_blocked","parent_available","cost_book_entry_blocked","cost_book_entry_valid","cost_book_reference_not_visible","unsupported_cost_book_uom","cost_uom_conversion_unavailable","cost_book_base_unavailable","cost_book_base_ambiguous","cost_ship_from_location_not_visible","cost_package_quantity_invalid","cost_component_invalid","cost_date_window_invalid","cost_date_overlap","cost_amount_overflow","cost_book_conflict","product_family_reference_active","product_packaging_reference_active","primary_child_available","primary_change_unsupported","reference_visibility_blocked","scope_authorized","stale_record","stale_cost_book_entry","supplier_reference_active","tag_applicable","tag_available","tag_exists","tag_found","tag_not_applicable","tag_not_found","type_immutable","type_known","type_required","target_active","target_available","target_not_found_or_not_visible","targets_visible","unsupported_linked_record","unsupported_profile_shape","variable_qty_valid","validation_failed","value_nonempty"]},"status":{"type":"string","enum":["passed","blocked"]},"message":{"type":"string"},"param":{"type":"string"}},"required":["code","status","message"],"additionalProperties":false}},"duplicateCandidates":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact","customer","supplier","customer_location","customer_address","supplier_ship_from_location","product","product_family","document"]},"readable":{"type":"boolean"},"version":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","product","purchase_order"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"matchReasons":{"type":"array","items":{"type":"string","enum":["name","email","externalId","address","code","product","url"]}},"readbackPath":{"type":"string"}},"required":["type","readable","matchReasons"],"additionalProperties":false}},"idempotency":{"type":"object","properties":{"required":{"type":"boolean"},"keyProvided":{"type":"boolean"},"wouldReplay":{"type":"boolean"}},"required":["required","keyProvided","wouldReplay"],"additionalProperties":false},"wouldChange":{"type":"object","properties":{"fieldNames":{"type":"array","items":{"type":"string"}},"values":{"type":"object","additionalProperties":{}}},"required":["fieldNames","values"],"additionalProperties":false},"impactAnalysis":{"type":"object","additionalProperties":{}},"requestId":{"type":"string"}},"required":["type","operation","status","wouldWrite","submit","verification","checks","duplicateCandidates","requestId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}]}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested parent or record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"409":{"description":"The write conflicted with an existing record, idempotency payload, or stale If-Match value.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/shipping-options/{id}/unarchive":{"post":{"operationId":"unarchivePublicAPIShippingOption","summary":"unarchive shipping option","description":"Archives or restores one Shipping Option while preserving its identity. Send an empty body with the latest updatedAt value in If-Match, or use dryRun=true to preview the action.","tags":["Shipping Options"],"security":[{"bearerAuth":[]}],"x-required-scope":"shipping-options:write","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","enum":["true"]},"required":false,"name":"dryRun","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check."},"required":false,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check.","name":"If-Match","in":"header"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false}}}},"responses":{"200":{"description":"Lifecycle receipt or readiness.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["lifecycle_receipt"]},"resource":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","customer_contact","supplier_contact","customer_address","supplier_ship_from_location","representative","product","warehouse","shipping_option"]},"kind":{"type":"string","enum":["salesperson","customer_service","supplier"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},"action":{"type":"string","enum":["archive","unarchive"]},"archived":{"type":"boolean"},"changed":{"type":"boolean"},"updatedAt":{"type":"string","format":"date-time"},"requestId":{"type":"string"},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false}},"required":["type","resource","action","archived","changed","updatedAt","requestId","verification"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["write_readiness"]},"operation":{"type":"string","enum":["warehouses.create","warehouses.update","warehouses.archive","warehouses.unarchive","shipping_options.create","shipping_options.update","shipping_options.archive","shipping_options.unarchive","reorder_points.create","tags.create","tags.update","tag_assignments.create","tag_assignments.delete","notes.create","notes.update","opportunities.create","opportunities.update","opportunities.close","opportunities.meta-upsert","contacts.create","contacts.update","customers.create","customers.update","customer_locations.create","customer_locations.update","customer_addresses.create","customer_addresses.update","suppliers.create","suppliers.update","supplier_ship_from_locations.create","supplier_ship_from_locations.update","products.create","products.update","products.archive","products.unarchive","product_packaging.create","products.suppliers.create","products.suppliers.delete","products.aliases.create","products.aliases.update","products.aliases.delete","product_families.aliases.create","product_families.aliases.update","product_families.aliases.delete","products.customer_part_numbers.create","products.customer_part_numbers.update","products.customer_part_numbers.delete","product_sds.update","product_documents.create","customer_documents.create","supplier_documents.create","purchase_order_documents.create","product_families.create","product_families.update","cost_book_entries.create","current_cost_sources.put","customers.archive","customers.unarchive","suppliers.archive","suppliers.unarchive","contacts.archive","contacts.unarchive","customer_addresses.archive","customer_addresses.unarchive","supplier_ship_from_locations.archive","supplier_ship_from_locations.unarchive","representatives.create","representatives.update","representatives.archive","representatives.unarchive","payment_terms.create","payment_terms.update","ledger_accounts.create","ledger_accounts.update"]},"status":{"type":"string","enum":["ready","blocked"]},"wouldWrite":{"type":"boolean","enum":[false]},"submit":{"type":"object","properties":{"method":{"type":"string","enum":["POST","PATCH","PUT","DELETE"]},"path":{"type":"string"},"query":{"type":"object","properties":{},"additionalProperties":false}},"required":["method","path","query"],"additionalProperties":false},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false},"checks":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["not_direct_ship","address_role_required","address_role_valid","already_assigned","already_exists","active_duplicate","ambiguous_external_id","ambiguous_natural_key","api_created","archived_target","archived_record","archive_blocked","account_type_locked","duplicate_candidate_found","duplicate_candidate_overflow","duplicate_check_clear","duplicate_check_not_needed","duplicate_contact","duplicate_customer","duplicate_customer_address","duplicate_customer_location","duplicate_note","duplicate_resolution_applied","duplicate_supplier","duplicate_supplier_ship_from_location","document_url_org_scoped","document_url_valid","upload_verified","sds_converged","idempotency_available","idempotency_key_required","idempotency_key_reused","idempotency_replay","idempotency_target_missing","income_statement_type_invalid","hard_identity_clear","nested_external_id_clear","commercial_references_valid","credit_denomination_mismatch","customer_service_representative_reference_active","ledger_account_reference_valid","payment_terms_reference_exists","sales_person_reference_active","supplier_representative_reference_active","duplicate_reference_identity","external_id_conflict","if_match_current","base_uom_transition_allowed","base_uom_transition_blocked","attribute_assignments_valid","attribute_assignments_invalid","selected_supplier_link","linked_records_available","natural_key_conflict","not_api_created","no_downstream_mutation","order_sensitive_update_allowed","order_sensitive_update_blocked","parent_available","cost_book_entry_blocked","cost_book_entry_valid","cost_book_reference_not_visible","unsupported_cost_book_uom","cost_uom_conversion_unavailable","cost_book_base_unavailable","cost_book_base_ambiguous","cost_ship_from_location_not_visible","cost_package_quantity_invalid","cost_component_invalid","cost_date_window_invalid","cost_date_overlap","cost_amount_overflow","cost_book_conflict","product_family_reference_active","product_packaging_reference_active","primary_child_available","primary_change_unsupported","reference_visibility_blocked","scope_authorized","stale_record","stale_cost_book_entry","supplier_reference_active","tag_applicable","tag_available","tag_exists","tag_found","tag_not_applicable","tag_not_found","type_immutable","type_known","type_required","target_active","target_available","target_not_found_or_not_visible","targets_visible","unsupported_linked_record","unsupported_profile_shape","variable_qty_valid","validation_failed","value_nonempty"]},"status":{"type":"string","enum":["passed","blocked"]},"message":{"type":"string"},"param":{"type":"string"}},"required":["code","status","message"],"additionalProperties":false}},"duplicateCandidates":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact","customer","supplier","customer_location","customer_address","supplier_ship_from_location","product","product_family","document"]},"readable":{"type":"boolean"},"version":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","product","purchase_order"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"matchReasons":{"type":"array","items":{"type":"string","enum":["name","email","externalId","address","code","product","url"]}},"readbackPath":{"type":"string"}},"required":["type","readable","matchReasons"],"additionalProperties":false}},"idempotency":{"type":"object","properties":{"required":{"type":"boolean"},"keyProvided":{"type":"boolean"},"wouldReplay":{"type":"boolean"}},"required":["required","keyProvided","wouldReplay"],"additionalProperties":false},"wouldChange":{"type":"object","properties":{"fieldNames":{"type":"array","items":{"type":"string"}},"values":{"type":"object","additionalProperties":{}}},"required":["fieldNames","values"],"additionalProperties":false},"impactAnalysis":{"type":"object","additionalProperties":{}},"requestId":{"type":"string"}},"required":["type","operation","status","wouldWrite","submit","verification","checks","duplicateCandidates","requestId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}]}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested parent or record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"409":{"description":"The write conflicted with an existing record, idempotency payload, or stale If-Match value.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/reorder-points":{"post":{"operationId":"writePublicAPIReorderPoints","summary":"Set or clear reorder points","description":"Sets or clears integer reorder points for 1 to 50 product-and-warehouse positions together. Use base units for variable products and package counts for fixed products. Zero or below clears a threshold, repeated values return changed:false, and dryRun=true previews the complete request. Review saved thresholds through GET /reorder-status.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"reorder:write","parameters":[{"schema":{"type":"string","enum":["true"]},"required":false,"name":"dryRun","in":"query"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"warehouseId":{"type":"string","format":"uuid"},"productId":{"type":"string","format":"uuid"},"reorderPoint":{"type":"integer","minimum":-2147483648,"maximum":2147483647}},"required":["warehouseId","productId","reorderPoint"],"additionalProperties":false},"minItems":1,"maxItems":50}},"required":["items"],"additionalProperties":false}}}},"responses":{"200":{"description":"Reorder-point results for each selected position, or preview result.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"data":{"type":"object","properties":{"changed":{"type":"boolean"},"items":{"type":"array","items":{"type":"object","properties":{"warehouseId":{"type":"string","format":"uuid"},"productId":{"type":"string","format":"uuid"},"reorderPoint":{"type":["integer","null"]},"changed":{"type":"boolean"}},"required":["warehouseId","productId","reorderPoint","changed"],"additionalProperties":false}}},"required":["changed","items"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["write_readiness"]},"operation":{"type":"string","enum":["warehouses.create","warehouses.update","warehouses.archive","warehouses.unarchive","shipping_options.create","shipping_options.update","shipping_options.archive","shipping_options.unarchive","reorder_points.create","tags.create","tags.update","tag_assignments.create","tag_assignments.delete","notes.create","notes.update","opportunities.create","opportunities.update","opportunities.close","opportunities.meta-upsert","contacts.create","contacts.update","customers.create","customers.update","customer_locations.create","customer_locations.update","customer_addresses.create","customer_addresses.update","suppliers.create","suppliers.update","supplier_ship_from_locations.create","supplier_ship_from_locations.update","products.create","products.update","products.archive","products.unarchive","product_packaging.create","products.suppliers.create","products.suppliers.delete","products.aliases.create","products.aliases.update","products.aliases.delete","product_families.aliases.create","product_families.aliases.update","product_families.aliases.delete","products.customer_part_numbers.create","products.customer_part_numbers.update","products.customer_part_numbers.delete","product_sds.update","product_documents.create","customer_documents.create","supplier_documents.create","purchase_order_documents.create","product_families.create","product_families.update","cost_book_entries.create","current_cost_sources.put","customers.archive","customers.unarchive","suppliers.archive","suppliers.unarchive","contacts.archive","contacts.unarchive","customer_addresses.archive","customer_addresses.unarchive","supplier_ship_from_locations.archive","supplier_ship_from_locations.unarchive","representatives.create","representatives.update","representatives.archive","representatives.unarchive","payment_terms.create","payment_terms.update","ledger_accounts.create","ledger_accounts.update"]},"status":{"type":"string","enum":["ready","blocked"]},"wouldWrite":{"type":"boolean","enum":[false]},"submit":{"type":"object","properties":{"method":{"type":"string","enum":["POST","PATCH","PUT","DELETE"]},"path":{"type":"string"},"query":{"type":"object","properties":{},"additionalProperties":false}},"required":["method","path","query"],"additionalProperties":false},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false},"checks":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["not_direct_ship","address_role_required","address_role_valid","already_assigned","already_exists","active_duplicate","ambiguous_external_id","ambiguous_natural_key","api_created","archived_target","archived_record","archive_blocked","account_type_locked","duplicate_candidate_found","duplicate_candidate_overflow","duplicate_check_clear","duplicate_check_not_needed","duplicate_contact","duplicate_customer","duplicate_customer_address","duplicate_customer_location","duplicate_note","duplicate_resolution_applied","duplicate_supplier","duplicate_supplier_ship_from_location","document_url_org_scoped","document_url_valid","upload_verified","sds_converged","idempotency_available","idempotency_key_required","idempotency_key_reused","idempotency_replay","idempotency_target_missing","income_statement_type_invalid","hard_identity_clear","nested_external_id_clear","commercial_references_valid","credit_denomination_mismatch","customer_service_representative_reference_active","ledger_account_reference_valid","payment_terms_reference_exists","sales_person_reference_active","supplier_representative_reference_active","duplicate_reference_identity","external_id_conflict","if_match_current","base_uom_transition_allowed","base_uom_transition_blocked","attribute_assignments_valid","attribute_assignments_invalid","selected_supplier_link","linked_records_available","natural_key_conflict","not_api_created","no_downstream_mutation","order_sensitive_update_allowed","order_sensitive_update_blocked","parent_available","cost_book_entry_blocked","cost_book_entry_valid","cost_book_reference_not_visible","unsupported_cost_book_uom","cost_uom_conversion_unavailable","cost_book_base_unavailable","cost_book_base_ambiguous","cost_ship_from_location_not_visible","cost_package_quantity_invalid","cost_component_invalid","cost_date_window_invalid","cost_date_overlap","cost_amount_overflow","cost_book_conflict","product_family_reference_active","product_packaging_reference_active","primary_child_available","primary_change_unsupported","reference_visibility_blocked","scope_authorized","stale_record","stale_cost_book_entry","supplier_reference_active","tag_applicable","tag_available","tag_exists","tag_found","tag_not_applicable","tag_not_found","type_immutable","type_known","type_required","target_active","target_available","target_not_found_or_not_visible","targets_visible","unsupported_linked_record","unsupported_profile_shape","variable_qty_valid","validation_failed","value_nonempty"]},"status":{"type":"string","enum":["passed","blocked"]},"message":{"type":"string"},"param":{"type":"string"}},"required":["code","status","message"],"additionalProperties":false}},"duplicateCandidates":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact","customer","supplier","customer_location","customer_address","supplier_ship_from_location","product","product_family","document"]},"readable":{"type":"boolean"},"version":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","product","purchase_order"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"matchReasons":{"type":"array","items":{"type":"string","enum":["name","email","externalId","address","code","product","url"]}},"readbackPath":{"type":"string"}},"required":["type","readable","matchReasons"],"additionalProperties":false}},"idempotency":{"type":"object","properties":{"required":{"type":"boolean"},"keyProvided":{"type":"boolean"},"wouldReplay":{"type":"boolean"}},"required":["required","keyProvided","wouldReplay"],"additionalProperties":false},"wouldChange":{"type":"object","properties":{"fieldNames":{"type":"array","items":{"type":"string"}},"values":{"type":"object","additionalProperties":{}}},"required":["fieldNames","values"],"additionalProperties":false},"impactAnalysis":{"type":"object","additionalProperties":{}},"requestId":{"type":"string"}},"required":["type","operation","status","wouldWrite","submit","verification","checks","duplicateCandidates","requestId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}]}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested parent or record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"409":{"description":"The write conflicted with an existing record, idempotency payload, or stale If-Match value.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/tags":{"get":{"operationId":"listPublicAPITags","summary":"List organization tags","description":"Returns stable tag IDs, untruncated labels, descriptions, and the public entity classes each tag applies to. The directory contains no assignment counts. Keep the original filters and limit unchanged, then continue with the exact returned nextCursor value; traversal is current-state and is not snapshot-isolated across requests.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"tags:read","parameters":[{"schema":{"type":"string","enum":["supplier","customer","product","product_family","contact","opportunity","sales_order","purchase_order","ship_to_address","ship_from_address"]},"required":false,"name":"entityType","in":"query"},{"schema":{"type":"string","pattern":"^\\d+$"},"required":false,"name":"limit","in":"query"},{"schema":{"type":"string","minLength":1,"maxLength":4096},"required":false,"name":"cursor","in":"query"}],"responses":{"200":{"description":"Available organization tags and continuation details.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"label":{"type":"string","minLength":1},"description":{"type":["string","null"]},"applicableEntityTypes":{"type":"array","items":{"type":"string","enum":["supplier","customer","product","product_family","contact","opportunity","sales_order","purchase_order","ship_to_address","ship_from_address"]},"minItems":1,"maxItems":10}},"required":["id","label","description","applicableEntityTypes"],"additionalProperties":false}},"meta":{"type":"object","properties":{"capabilityKey":{"type":"string","enum":["list_tags"]},"capabilityVersion":{"type":"string","minLength":1},"returnedRecords":{"type":"integer","minimum":0},"populationCount":{"type":["integer","null"],"minimum":0},"complete":{"type":"boolean"},"hasMore":{"type":"boolean"},"nextCursor":{"type":["string","null"]},"ordering":{"type":"string","enum":["label_id"]},"currentState":{"type":"boolean","enum":[true]},"snapshotIsolatedAcrossRequests":{"type":"boolean","enum":[false]},"requestId":{"type":"string"}},"required":["capabilityKey","capabilityVersion","returnedRecords","populationCount","complete","hasMore","nextCursor","ordering","currentState","snapshotIsolatedAcrossRequests","requestId"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}},"post":{"operationId":"createPublicAPITag","summary":"Create an organization tag","description":"Creates an organization tag. Repeating the same tag leaves it unchanged, and dryRun=true previews the request without saving it. applicableEntityTypes uses the same vocabulary as GET /api/v1/tags: the full class roster means unrestricted.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"tags:write","parameters":[{"schema":{"type":"string","enum":["true"]},"required":false,"name":"dryRun","in":"query"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"label":{"type":"string","minLength":1,"maxLength":120},"description":{"type":["string","null"],"maxLength":4000},"applicableEntityTypes":{"type":"array","items":{"type":"string","enum":["supplier","customer","product","product_family","contact","opportunity","sales_order","purchase_order","ship_to_address","ship_from_address"]},"maxItems":10,"description":"Public classes this tag applies to. Unrestricted tags list every class; send that full roster or omit the field on create to keep a tag unrestricted."}},"required":["label"],"additionalProperties":false}}}},"responses":{"200":{"description":"Existing tag returned unchanged, or preview result.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"label":{"type":"string","minLength":1},"description":{"type":["string","null"]},"applicableEntityTypes":{"type":"array","items":{"type":"string","enum":["supplier","customer","product","product_family","contact","opportunity","sales_order","purchase_order","ship_to_address","ship_from_address"]},"description":"Public classes this tag applies to. Unrestricted tags list every class; send that full roster or omit the field on create to keep a tag unrestricted. A subset restricts the tag and unlinks assignments outside the set."},"changed":{"type":"boolean"},"removedEntityTypes":{"type":"array","items":{"type":"string","enum":["supplier","customer","product","product_family","contact","opportunity","sales_order","purchase_order","ship_to_address","ship_from_address"]}}},"required":["id","label","description","applicableEntityTypes","changed"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["write_readiness"]},"operation":{"type":"string","enum":["warehouses.create","warehouses.update","warehouses.archive","warehouses.unarchive","shipping_options.create","shipping_options.update","shipping_options.archive","shipping_options.unarchive","reorder_points.create","tags.create","tags.update","tag_assignments.create","tag_assignments.delete","notes.create","notes.update","opportunities.create","opportunities.update","opportunities.close","opportunities.meta-upsert","contacts.create","contacts.update","customers.create","customers.update","customer_locations.create","customer_locations.update","customer_addresses.create","customer_addresses.update","suppliers.create","suppliers.update","supplier_ship_from_locations.create","supplier_ship_from_locations.update","products.create","products.update","products.archive","products.unarchive","product_packaging.create","products.suppliers.create","products.suppliers.delete","products.aliases.create","products.aliases.update","products.aliases.delete","product_families.aliases.create","product_families.aliases.update","product_families.aliases.delete","products.customer_part_numbers.create","products.customer_part_numbers.update","products.customer_part_numbers.delete","product_sds.update","product_documents.create","customer_documents.create","supplier_documents.create","purchase_order_documents.create","product_families.create","product_families.update","cost_book_entries.create","current_cost_sources.put","customers.archive","customers.unarchive","suppliers.archive","suppliers.unarchive","contacts.archive","contacts.unarchive","customer_addresses.archive","customer_addresses.unarchive","supplier_ship_from_locations.archive","supplier_ship_from_locations.unarchive","representatives.create","representatives.update","representatives.archive","representatives.unarchive","payment_terms.create","payment_terms.update","ledger_accounts.create","ledger_accounts.update"]},"status":{"type":"string","enum":["ready","blocked"]},"wouldWrite":{"type":"boolean","enum":[false]},"submit":{"type":"object","properties":{"method":{"type":"string","enum":["POST","PATCH","PUT","DELETE"]},"path":{"type":"string"},"query":{"type":"object","properties":{},"additionalProperties":false}},"required":["method","path","query"],"additionalProperties":false},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false},"checks":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["not_direct_ship","address_role_required","address_role_valid","already_assigned","already_exists","active_duplicate","ambiguous_external_id","ambiguous_natural_key","api_created","archived_target","archived_record","archive_blocked","account_type_locked","duplicate_candidate_found","duplicate_candidate_overflow","duplicate_check_clear","duplicate_check_not_needed","duplicate_contact","duplicate_customer","duplicate_customer_address","duplicate_customer_location","duplicate_note","duplicate_resolution_applied","duplicate_supplier","duplicate_supplier_ship_from_location","document_url_org_scoped","document_url_valid","upload_verified","sds_converged","idempotency_available","idempotency_key_required","idempotency_key_reused","idempotency_replay","idempotency_target_missing","income_statement_type_invalid","hard_identity_clear","nested_external_id_clear","commercial_references_valid","credit_denomination_mismatch","customer_service_representative_reference_active","ledger_account_reference_valid","payment_terms_reference_exists","sales_person_reference_active","supplier_representative_reference_active","duplicate_reference_identity","external_id_conflict","if_match_current","base_uom_transition_allowed","base_uom_transition_blocked","attribute_assignments_valid","attribute_assignments_invalid","selected_supplier_link","linked_records_available","natural_key_conflict","not_api_created","no_downstream_mutation","order_sensitive_update_allowed","order_sensitive_update_blocked","parent_available","cost_book_entry_blocked","cost_book_entry_valid","cost_book_reference_not_visible","unsupported_cost_book_uom","cost_uom_conversion_unavailable","cost_book_base_unavailable","cost_book_base_ambiguous","cost_ship_from_location_not_visible","cost_package_quantity_invalid","cost_component_invalid","cost_date_window_invalid","cost_date_overlap","cost_amount_overflow","cost_book_conflict","product_family_reference_active","product_packaging_reference_active","primary_child_available","primary_change_unsupported","reference_visibility_blocked","scope_authorized","stale_record","stale_cost_book_entry","supplier_reference_active","tag_applicable","tag_available","tag_exists","tag_found","tag_not_applicable","tag_not_found","type_immutable","type_known","type_required","target_active","target_available","target_not_found_or_not_visible","targets_visible","unsupported_linked_record","unsupported_profile_shape","variable_qty_valid","validation_failed","value_nonempty"]},"status":{"type":"string","enum":["passed","blocked"]},"message":{"type":"string"},"param":{"type":"string"}},"required":["code","status","message"],"additionalProperties":false}},"duplicateCandidates":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact","customer","supplier","customer_location","customer_address","supplier_ship_from_location","product","product_family","document"]},"readable":{"type":"boolean"},"version":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","product","purchase_order"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"matchReasons":{"type":"array","items":{"type":"string","enum":["name","email","externalId","address","code","product","url"]}},"readbackPath":{"type":"string"}},"required":["type","readable","matchReasons"],"additionalProperties":false}},"idempotency":{"type":"object","properties":{"required":{"type":"boolean"},"keyProvided":{"type":"boolean"},"wouldReplay":{"type":"boolean"}},"required":["required","keyProvided","wouldReplay"],"additionalProperties":false},"wouldChange":{"type":"object","properties":{"fieldNames":{"type":"array","items":{"type":"string"}},"values":{"type":"object","additionalProperties":{}}},"required":["fieldNames","values"],"additionalProperties":false},"impactAnalysis":{"type":"object","additionalProperties":{}},"requestId":{"type":"string"}},"required":["type","operation","status","wouldWrite","submit","verification","checks","duplicateCandidates","requestId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}]}}}},"201":{"description":"Created tag.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"label":{"type":"string","minLength":1},"description":{"type":["string","null"]},"applicableEntityTypes":{"type":"array","items":{"type":"string","enum":["supplier","customer","product","product_family","contact","opportunity","sales_order","purchase_order","ship_to_address","ship_from_address"]},"description":"Public classes this tag applies to. Unrestricted tags list every class; send that full roster or omit the field on create to keep a tag unrestricted. A subset restricts the tag and unlinks assignments outside the set."},"changed":{"type":"boolean"},"removedEntityTypes":{"type":"array","items":{"type":"string","enum":["supplier","customer","product","product_family","contact","opportunity","sales_order","purchase_order","ship_to_address","ship_from_address"]}}},"required":["id","label","description","applicableEntityTypes","changed"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/tags/{id}":{"patch":{"operationId":"updatePublicAPITag","summary":"Update an organization tag","description":"Updates label, description, or applicableEntityTypes; dryRun=true writes nothing. Unrestricted tags list every class; sending that full roster keeps the tag unrestricted.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"tags:write","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","enum":["true"]},"required":false,"name":"dryRun","in":"query"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"label":{"type":"string","minLength":1,"maxLength":120},"description":{"type":["string","null"],"maxLength":4000},"applicableEntityTypes":{"type":"array","items":{"type":"string","enum":["supplier","customer","product","product_family","contact","opportunity","sales_order","purchase_order","ship_to_address","ship_from_address"]},"maxItems":10,"description":"Public classes this tag applies to. Unrestricted tags list every class; send that full roster or omit the field on create to keep a tag unrestricted."}},"additionalProperties":false}}}},"responses":{"200":{"description":"Updated or unchanged tag, or preview result.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"label":{"type":"string","minLength":1},"description":{"type":["string","null"]},"applicableEntityTypes":{"type":"array","items":{"type":"string","enum":["supplier","customer","product","product_family","contact","opportunity","sales_order","purchase_order","ship_to_address","ship_from_address"]},"description":"Public classes this tag applies to. Unrestricted tags list every class; send that full roster or omit the field on create to keep a tag unrestricted. A subset restricts the tag and unlinks assignments outside the set."},"changed":{"type":"boolean"},"removedEntityTypes":{"type":"array","items":{"type":"string","enum":["supplier","customer","product","product_family","contact","opportunity","sales_order","purchase_order","ship_to_address","ship_from_address"]}}},"required":["id","label","description","applicableEntityTypes","changed"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["write_readiness"]},"operation":{"type":"string","enum":["warehouses.create","warehouses.update","warehouses.archive","warehouses.unarchive","shipping_options.create","shipping_options.update","shipping_options.archive","shipping_options.unarchive","reorder_points.create","tags.create","tags.update","tag_assignments.create","tag_assignments.delete","notes.create","notes.update","opportunities.create","opportunities.update","opportunities.close","opportunities.meta-upsert","contacts.create","contacts.update","customers.create","customers.update","customer_locations.create","customer_locations.update","customer_addresses.create","customer_addresses.update","suppliers.create","suppliers.update","supplier_ship_from_locations.create","supplier_ship_from_locations.update","products.create","products.update","products.archive","products.unarchive","product_packaging.create","products.suppliers.create","products.suppliers.delete","products.aliases.create","products.aliases.update","products.aliases.delete","product_families.aliases.create","product_families.aliases.update","product_families.aliases.delete","products.customer_part_numbers.create","products.customer_part_numbers.update","products.customer_part_numbers.delete","product_sds.update","product_documents.create","customer_documents.create","supplier_documents.create","purchase_order_documents.create","product_families.create","product_families.update","cost_book_entries.create","current_cost_sources.put","customers.archive","customers.unarchive","suppliers.archive","suppliers.unarchive","contacts.archive","contacts.unarchive","customer_addresses.archive","customer_addresses.unarchive","supplier_ship_from_locations.archive","supplier_ship_from_locations.unarchive","representatives.create","representatives.update","representatives.archive","representatives.unarchive","payment_terms.create","payment_terms.update","ledger_accounts.create","ledger_accounts.update"]},"status":{"type":"string","enum":["ready","blocked"]},"wouldWrite":{"type":"boolean","enum":[false]},"submit":{"type":"object","properties":{"method":{"type":"string","enum":["POST","PATCH","PUT","DELETE"]},"path":{"type":"string"},"query":{"type":"object","properties":{},"additionalProperties":false}},"required":["method","path","query"],"additionalProperties":false},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false},"checks":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["not_direct_ship","address_role_required","address_role_valid","already_assigned","already_exists","active_duplicate","ambiguous_external_id","ambiguous_natural_key","api_created","archived_target","archived_record","archive_blocked","account_type_locked","duplicate_candidate_found","duplicate_candidate_overflow","duplicate_check_clear","duplicate_check_not_needed","duplicate_contact","duplicate_customer","duplicate_customer_address","duplicate_customer_location","duplicate_note","duplicate_resolution_applied","duplicate_supplier","duplicate_supplier_ship_from_location","document_url_org_scoped","document_url_valid","upload_verified","sds_converged","idempotency_available","idempotency_key_required","idempotency_key_reused","idempotency_replay","idempotency_target_missing","income_statement_type_invalid","hard_identity_clear","nested_external_id_clear","commercial_references_valid","credit_denomination_mismatch","customer_service_representative_reference_active","ledger_account_reference_valid","payment_terms_reference_exists","sales_person_reference_active","supplier_representative_reference_active","duplicate_reference_identity","external_id_conflict","if_match_current","base_uom_transition_allowed","base_uom_transition_blocked","attribute_assignments_valid","attribute_assignments_invalid","selected_supplier_link","linked_records_available","natural_key_conflict","not_api_created","no_downstream_mutation","order_sensitive_update_allowed","order_sensitive_update_blocked","parent_available","cost_book_entry_blocked","cost_book_entry_valid","cost_book_reference_not_visible","unsupported_cost_book_uom","cost_uom_conversion_unavailable","cost_book_base_unavailable","cost_book_base_ambiguous","cost_ship_from_location_not_visible","cost_package_quantity_invalid","cost_component_invalid","cost_date_window_invalid","cost_date_overlap","cost_amount_overflow","cost_book_conflict","product_family_reference_active","product_packaging_reference_active","primary_child_available","primary_change_unsupported","reference_visibility_blocked","scope_authorized","stale_record","stale_cost_book_entry","supplier_reference_active","tag_applicable","tag_available","tag_exists","tag_found","tag_not_applicable","tag_not_found","type_immutable","type_known","type_required","target_active","target_available","target_not_found_or_not_visible","targets_visible","unsupported_linked_record","unsupported_profile_shape","variable_qty_valid","validation_failed","value_nonempty"]},"status":{"type":"string","enum":["passed","blocked"]},"message":{"type":"string"},"param":{"type":"string"}},"required":["code","status","message"],"additionalProperties":false}},"duplicateCandidates":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact","customer","supplier","customer_location","customer_address","supplier_ship_from_location","product","product_family","document"]},"readable":{"type":"boolean"},"version":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","product","purchase_order"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"matchReasons":{"type":"array","items":{"type":"string","enum":["name","email","externalId","address","code","product","url"]}},"readbackPath":{"type":"string"}},"required":["type","readable","matchReasons"],"additionalProperties":false}},"idempotency":{"type":"object","properties":{"required":{"type":"boolean"},"keyProvided":{"type":"boolean"},"wouldReplay":{"type":"boolean"}},"required":["required","keyProvided","wouldReplay"],"additionalProperties":false},"wouldChange":{"type":"object","properties":{"fieldNames":{"type":"array","items":{"type":"string"}},"values":{"type":"object","additionalProperties":{}}},"required":["fieldNames","values"],"additionalProperties":false},"impactAnalysis":{"type":"object","additionalProperties":{}},"requestId":{"type":"string"}},"required":["type","operation","status","wouldWrite","submit","verification","checks","duplicateCandidates","requestId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}]}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"Tag not found.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/tag-assignments":{"get":{"operationId":"listPublicAPITagAssignments","summary":"Read tags assigned to one record","description":"Returns the tags currently assigned to one available record. Use the customer- or supplier-contact ID for contact, and the customer address ID for ship_to_address.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"tags:read","parameters":[{"schema":{"type":"string","enum":["supplier","customer","product","product_family","contact","opportunity","sales_order","purchase_order","ship_to_address","ship_from_address"],"description":"Record class to read. contact covers Contact and SupplierContact; ship_to_address is a customer location address."},"required":true,"description":"Record class to read. contact covers Contact and SupplierContact; ship_to_address is a customer location address.","name":"entityType","in":"query"},{"schema":{"type":"string","format":"uuid","description":"Record ID in that class's identity space: contact is Contact.id or SupplierContact.id; opportunity is Opportunity.id; ship_to_address is CustomerLocationAddress.id, not the location id; ship_from_address is ShipFromLocation.id."},"required":true,"description":"Record ID in that class's identity space: contact is Contact.id or SupplierContact.id; opportunity is Opportunity.id; ship_to_address is CustomerLocationAddress.id, not the location id; ship_from_address is ShipFromLocation.id.","name":"entityId","in":"query"}],"responses":{"200":{"description":"Current tag assignments.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"entityType":{"type":"string","enum":["supplier","customer","product","product_family","contact","opportunity","sales_order","purchase_order","ship_to_address","ship_from_address"]},"entityId":{"type":"string","format":"uuid"},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"label":{"type":"string","minLength":1},"description":{"type":["string","null"]},"applicableEntityTypes":{"type":"array","items":{"type":"string","enum":["supplier","customer","product","product_family","contact","opportunity","sales_order","purchase_order","ship_to_address","ship_from_address"]},"description":"Public classes this tag applies to. Unrestricted tags list every class; send that full roster or omit the field on create to keep a tag unrestricted. A subset restricts the tag and unlinks assignments outside the set."},"changed":{"type":"boolean"}},"required":["id","label","description","applicableEntityTypes","changed"],"additionalProperties":false}}},"required":["entityType","entityId","tags"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}},"post":{"operationId":"assignPublicAPITags","summary":"Assign one tag to records","description":"Assigns or removes one tag for up to 50 records together. Repeating the same request leaves completed assignments unchanged. contact IDs are Contact.id or SupplierContact.id; opportunity IDs are Opportunity.id; ship_to_address IDs are CustomerLocationAddress.id, not the customer location id; ship_from_address IDs are ShipFromLocation.id.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"tags:write","parameters":[{"schema":{"type":"string","enum":["true"]},"required":false,"name":"dryRun","in":"query"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"tagId":{"type":"string","format":"uuid"},"entityType":{"type":"string","enum":["supplier","customer","product","product_family","contact","opportunity","sales_order","purchase_order","ship_to_address","ship_from_address"],"description":"Record class to assign. contact covers Contact and SupplierContact; opportunity is Opportunity; ship_to_address is a customer location address; ship_from_address is a supplier ship-from location."},"entityIds":{"type":"array","items":{"type":"string","format":"uuid"},"minItems":1,"maxItems":50,"description":"Record IDs for entityType. contact is Contact.id or SupplierContact.id; opportunity is Opportunity.id; ship_to_address is CustomerLocationAddress.id, not the customer location id; ship_from_address is ShipFromLocation.id. Other classes use the same ids as their public detail routes."},"includeArchived":{"type":"boolean"}},"required":["tagId","entityType","entityIds"],"additionalProperties":false}}}},"responses":{"200":{"description":"Assignment results for every selected record, or preview result.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"data":{"type":"object","properties":{"tag":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"label":{"type":"string","minLength":1},"description":{"type":["string","null"]},"applicableEntityTypes":{"type":"array","items":{"type":"string","enum":["supplier","customer","product","product_family","contact","opportunity","sales_order","purchase_order","ship_to_address","ship_from_address"]},"description":"Public classes this tag applies to. Unrestricted tags list every class; send that full roster or omit the field on create to keep a tag unrestricted. A subset restricts the tag and unlinks assignments outside the set."},"changed":{"type":"boolean"}},"required":["id","label","description","applicableEntityTypes","changed"],"additionalProperties":false},"entityType":{"type":"string","enum":["supplier","customer","product","product_family","contact","opportunity","sales_order","purchase_order","ship_to_address","ship_from_address"]},"assignments":{"type":"array","items":{"type":"object","properties":{"entityClass":{"type":"string","enum":["supplier","customer","product","product_family","contact","opportunity","sales_order","purchase_order","ship_to_address","ship_from_address"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string","minLength":1},"externalId":{"type":["string","null"]},"archived":{"type":"boolean"},"entityId":{"type":"string","format":"uuid"},"changed":{"type":"boolean"}},"required":["entityClass","id","displayName","externalId","archived","entityId","changed"],"additionalProperties":false}}},"required":["tag","entityType","assignments"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["write_readiness"]},"operation":{"type":"string","enum":["warehouses.create","warehouses.update","warehouses.archive","warehouses.unarchive","shipping_options.create","shipping_options.update","shipping_options.archive","shipping_options.unarchive","reorder_points.create","tags.create","tags.update","tag_assignments.create","tag_assignments.delete","notes.create","notes.update","opportunities.create","opportunities.update","opportunities.close","opportunities.meta-upsert","contacts.create","contacts.update","customers.create","customers.update","customer_locations.create","customer_locations.update","customer_addresses.create","customer_addresses.update","suppliers.create","suppliers.update","supplier_ship_from_locations.create","supplier_ship_from_locations.update","products.create","products.update","products.archive","products.unarchive","product_packaging.create","products.suppliers.create","products.suppliers.delete","products.aliases.create","products.aliases.update","products.aliases.delete","product_families.aliases.create","product_families.aliases.update","product_families.aliases.delete","products.customer_part_numbers.create","products.customer_part_numbers.update","products.customer_part_numbers.delete","product_sds.update","product_documents.create","customer_documents.create","supplier_documents.create","purchase_order_documents.create","product_families.create","product_families.update","cost_book_entries.create","current_cost_sources.put","customers.archive","customers.unarchive","suppliers.archive","suppliers.unarchive","contacts.archive","contacts.unarchive","customer_addresses.archive","customer_addresses.unarchive","supplier_ship_from_locations.archive","supplier_ship_from_locations.unarchive","representatives.create","representatives.update","representatives.archive","representatives.unarchive","payment_terms.create","payment_terms.update","ledger_accounts.create","ledger_accounts.update"]},"status":{"type":"string","enum":["ready","blocked"]},"wouldWrite":{"type":"boolean","enum":[false]},"submit":{"type":"object","properties":{"method":{"type":"string","enum":["POST","PATCH","PUT","DELETE"]},"path":{"type":"string"},"query":{"type":"object","properties":{},"additionalProperties":false}},"required":["method","path","query"],"additionalProperties":false},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false},"checks":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["not_direct_ship","address_role_required","address_role_valid","already_assigned","already_exists","active_duplicate","ambiguous_external_id","ambiguous_natural_key","api_created","archived_target","archived_record","archive_blocked","account_type_locked","duplicate_candidate_found","duplicate_candidate_overflow","duplicate_check_clear","duplicate_check_not_needed","duplicate_contact","duplicate_customer","duplicate_customer_address","duplicate_customer_location","duplicate_note","duplicate_resolution_applied","duplicate_supplier","duplicate_supplier_ship_from_location","document_url_org_scoped","document_url_valid","upload_verified","sds_converged","idempotency_available","idempotency_key_required","idempotency_key_reused","idempotency_replay","idempotency_target_missing","income_statement_type_invalid","hard_identity_clear","nested_external_id_clear","commercial_references_valid","credit_denomination_mismatch","customer_service_representative_reference_active","ledger_account_reference_valid","payment_terms_reference_exists","sales_person_reference_active","supplier_representative_reference_active","duplicate_reference_identity","external_id_conflict","if_match_current","base_uom_transition_allowed","base_uom_transition_blocked","attribute_assignments_valid","attribute_assignments_invalid","selected_supplier_link","linked_records_available","natural_key_conflict","not_api_created","no_downstream_mutation","order_sensitive_update_allowed","order_sensitive_update_blocked","parent_available","cost_book_entry_blocked","cost_book_entry_valid","cost_book_reference_not_visible","unsupported_cost_book_uom","cost_uom_conversion_unavailable","cost_book_base_unavailable","cost_book_base_ambiguous","cost_ship_from_location_not_visible","cost_package_quantity_invalid","cost_component_invalid","cost_date_window_invalid","cost_date_overlap","cost_amount_overflow","cost_book_conflict","product_family_reference_active","product_packaging_reference_active","primary_child_available","primary_change_unsupported","reference_visibility_blocked","scope_authorized","stale_record","stale_cost_book_entry","supplier_reference_active","tag_applicable","tag_available","tag_exists","tag_found","tag_not_applicable","tag_not_found","type_immutable","type_known","type_required","target_active","target_available","target_not_found_or_not_visible","targets_visible","unsupported_linked_record","unsupported_profile_shape","variable_qty_valid","validation_failed","value_nonempty"]},"status":{"type":"string","enum":["passed","blocked"]},"message":{"type":"string"},"param":{"type":"string"}},"required":["code","status","message"],"additionalProperties":false}},"duplicateCandidates":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact","customer","supplier","customer_location","customer_address","supplier_ship_from_location","product","product_family","document"]},"readable":{"type":"boolean"},"version":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","product","purchase_order"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"matchReasons":{"type":"array","items":{"type":"string","enum":["name","email","externalId","address","code","product","url"]}},"readbackPath":{"type":"string"}},"required":["type","readable","matchReasons"],"additionalProperties":false}},"idempotency":{"type":"object","properties":{"required":{"type":"boolean"},"keyProvided":{"type":"boolean"},"wouldReplay":{"type":"boolean"}},"required":["required","keyProvided","wouldReplay"],"additionalProperties":false},"wouldChange":{"type":"object","properties":{"fieldNames":{"type":"array","items":{"type":"string"}},"values":{"type":"object","additionalProperties":{}}},"required":["fieldNames","values"],"additionalProperties":false},"impactAnalysis":{"type":"object","additionalProperties":{}},"requestId":{"type":"string"}},"required":["type","operation","status","wouldWrite","submit","verification","checks","duplicateCandidates","requestId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}]}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"Tag or target not found or not visible.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}},"delete":{"operationId":"unassignPublicAPITags","summary":"Remove one tag from records","description":"Assigns or removes one tag for up to 50 records together. Repeating the same request leaves completed assignments unchanged. contact IDs are Contact.id or SupplierContact.id; opportunity IDs are Opportunity.id; ship_to_address IDs are CustomerLocationAddress.id, not the customer location id; ship_from_address IDs are ShipFromLocation.id.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"tags:write","parameters":[{"schema":{"type":"string","enum":["true"]},"required":false,"name":"dryRun","in":"query"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"tagId":{"type":"string","format":"uuid"},"entityType":{"type":"string","enum":["supplier","customer","product","product_family","contact","opportunity","sales_order","purchase_order","ship_to_address","ship_from_address"],"description":"Record class to assign. contact covers Contact and SupplierContact; opportunity is Opportunity; ship_to_address is a customer location address; ship_from_address is a supplier ship-from location."},"entityIds":{"type":"array","items":{"type":"string","format":"uuid"},"minItems":1,"maxItems":50,"description":"Record IDs for entityType. contact is Contact.id or SupplierContact.id; opportunity is Opportunity.id; ship_to_address is CustomerLocationAddress.id, not the customer location id; ship_from_address is ShipFromLocation.id. Other classes use the same ids as their public detail routes."},"includeArchived":{"type":"boolean"}},"required":["tagId","entityType","entityIds"],"additionalProperties":false}}}},"responses":{"200":{"description":"Assignment results for every selected record, or preview result.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"data":{"type":"object","properties":{"tag":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"label":{"type":"string","minLength":1},"description":{"type":["string","null"]},"applicableEntityTypes":{"type":"array","items":{"type":"string","enum":["supplier","customer","product","product_family","contact","opportunity","sales_order","purchase_order","ship_to_address","ship_from_address"]},"description":"Public classes this tag applies to. Unrestricted tags list every class; send that full roster or omit the field on create to keep a tag unrestricted. A subset restricts the tag and unlinks assignments outside the set."},"changed":{"type":"boolean"}},"required":["id","label","description","applicableEntityTypes","changed"],"additionalProperties":false},"entityType":{"type":"string","enum":["supplier","customer","product","product_family","contact","opportunity","sales_order","purchase_order","ship_to_address","ship_from_address"]},"assignments":{"type":"array","items":{"type":"object","properties":{"entityClass":{"type":"string","enum":["supplier","customer","product","product_family","contact","opportunity","sales_order","purchase_order","ship_to_address","ship_from_address"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string","minLength":1},"externalId":{"type":["string","null"]},"archived":{"type":"boolean"},"entityId":{"type":"string","format":"uuid"},"changed":{"type":"boolean"}},"required":["entityClass","id","displayName","externalId","archived","entityId","changed"],"additionalProperties":false}}},"required":["tag","entityType","assignments"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["write_readiness"]},"operation":{"type":"string","enum":["warehouses.create","warehouses.update","warehouses.archive","warehouses.unarchive","shipping_options.create","shipping_options.update","shipping_options.archive","shipping_options.unarchive","reorder_points.create","tags.create","tags.update","tag_assignments.create","tag_assignments.delete","notes.create","notes.update","opportunities.create","opportunities.update","opportunities.close","opportunities.meta-upsert","contacts.create","contacts.update","customers.create","customers.update","customer_locations.create","customer_locations.update","customer_addresses.create","customer_addresses.update","suppliers.create","suppliers.update","supplier_ship_from_locations.create","supplier_ship_from_locations.update","products.create","products.update","products.archive","products.unarchive","product_packaging.create","products.suppliers.create","products.suppliers.delete","products.aliases.create","products.aliases.update","products.aliases.delete","product_families.aliases.create","product_families.aliases.update","product_families.aliases.delete","products.customer_part_numbers.create","products.customer_part_numbers.update","products.customer_part_numbers.delete","product_sds.update","product_documents.create","customer_documents.create","supplier_documents.create","purchase_order_documents.create","product_families.create","product_families.update","cost_book_entries.create","current_cost_sources.put","customers.archive","customers.unarchive","suppliers.archive","suppliers.unarchive","contacts.archive","contacts.unarchive","customer_addresses.archive","customer_addresses.unarchive","supplier_ship_from_locations.archive","supplier_ship_from_locations.unarchive","representatives.create","representatives.update","representatives.archive","representatives.unarchive","payment_terms.create","payment_terms.update","ledger_accounts.create","ledger_accounts.update"]},"status":{"type":"string","enum":["ready","blocked"]},"wouldWrite":{"type":"boolean","enum":[false]},"submit":{"type":"object","properties":{"method":{"type":"string","enum":["POST","PATCH","PUT","DELETE"]},"path":{"type":"string"},"query":{"type":"object","properties":{},"additionalProperties":false}},"required":["method","path","query"],"additionalProperties":false},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false},"checks":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["not_direct_ship","address_role_required","address_role_valid","already_assigned","already_exists","active_duplicate","ambiguous_external_id","ambiguous_natural_key","api_created","archived_target","archived_record","archive_blocked","account_type_locked","duplicate_candidate_found","duplicate_candidate_overflow","duplicate_check_clear","duplicate_check_not_needed","duplicate_contact","duplicate_customer","duplicate_customer_address","duplicate_customer_location","duplicate_note","duplicate_resolution_applied","duplicate_supplier","duplicate_supplier_ship_from_location","document_url_org_scoped","document_url_valid","upload_verified","sds_converged","idempotency_available","idempotency_key_required","idempotency_key_reused","idempotency_replay","idempotency_target_missing","income_statement_type_invalid","hard_identity_clear","nested_external_id_clear","commercial_references_valid","credit_denomination_mismatch","customer_service_representative_reference_active","ledger_account_reference_valid","payment_terms_reference_exists","sales_person_reference_active","supplier_representative_reference_active","duplicate_reference_identity","external_id_conflict","if_match_current","base_uom_transition_allowed","base_uom_transition_blocked","attribute_assignments_valid","attribute_assignments_invalid","selected_supplier_link","linked_records_available","natural_key_conflict","not_api_created","no_downstream_mutation","order_sensitive_update_allowed","order_sensitive_update_blocked","parent_available","cost_book_entry_blocked","cost_book_entry_valid","cost_book_reference_not_visible","unsupported_cost_book_uom","cost_uom_conversion_unavailable","cost_book_base_unavailable","cost_book_base_ambiguous","cost_ship_from_location_not_visible","cost_package_quantity_invalid","cost_component_invalid","cost_date_window_invalid","cost_date_overlap","cost_amount_overflow","cost_book_conflict","product_family_reference_active","product_packaging_reference_active","primary_child_available","primary_change_unsupported","reference_visibility_blocked","scope_authorized","stale_record","stale_cost_book_entry","supplier_reference_active","tag_applicable","tag_available","tag_exists","tag_found","tag_not_applicable","tag_not_found","type_immutable","type_known","type_required","target_active","target_available","target_not_found_or_not_visible","targets_visible","unsupported_linked_record","unsupported_profile_shape","variable_qty_valid","validation_failed","value_nonempty"]},"status":{"type":"string","enum":["passed","blocked"]},"message":{"type":"string"},"param":{"type":"string"}},"required":["code","status","message"],"additionalProperties":false}},"duplicateCandidates":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact","customer","supplier","customer_location","customer_address","supplier_ship_from_location","product","product_family","document"]},"readable":{"type":"boolean"},"version":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","product","purchase_order"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"matchReasons":{"type":"array","items":{"type":"string","enum":["name","email","externalId","address","code","product","url"]}},"readbackPath":{"type":"string"}},"required":["type","readable","matchReasons"],"additionalProperties":false}},"idempotency":{"type":"object","properties":{"required":{"type":"boolean"},"keyProvided":{"type":"boolean"},"wouldReplay":{"type":"boolean"}},"required":["required","keyProvided","wouldReplay"],"additionalProperties":false},"wouldChange":{"type":"object","properties":{"fieldNames":{"type":"array","items":{"type":"string"}},"values":{"type":"object","additionalProperties":{}}},"required":["fieldNames","values"],"additionalProperties":false},"impactAnalysis":{"type":"object","additionalProperties":{}},"requestId":{"type":"string"}},"required":["type","operation","status","wouldWrite","submit","verification","checks","duplicateCandidates","requestId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}]}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"Tag or target not found or not visible.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/tagged-records":{"get":{"operationId":"findPublicAPITaggedRecords","summary":"List records carrying an exact tag","description":"Requires one entityType and exactly one tagId or case-normalized label. Returns identity-only rows under live tag and entity-class view permissions; fuzzy tagQuery is not accepted. Keep the original filters and limit unchanged, then continue with the exact returned nextCursor value.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"tags:read","parameters":[{"schema":{"type":"string","format":"uuid"},"required":false,"name":"tagId","in":"query"},{"schema":{"type":"string","minLength":1},"required":false,"name":"label","in":"query"},{"schema":{"type":"string","enum":["supplier","customer","product","product_family","contact","opportunity","sales_order","purchase_order","ship_to_address","ship_from_address"]},"required":true,"name":"entityType","in":"query"},{"schema":{"type":"string","minLength":1,"maxLength":120},"required":false,"name":"nameQuery","in":"query"},{"schema":{"type":"string","enum":["true","false"]},"required":false,"name":"includeArchived","in":"query"},{"schema":{"type":"string","pattern":"^\\d+$"},"required":false,"name":"limit","in":"query"},{"schema":{"type":"string","minLength":1,"maxLength":4096},"required":false,"name":"cursor","in":"query"}],"responses":{"200":{"description":"Tag details and matching available records.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"resolvedTag":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"label":{"type":"string","minLength":1},"description":{"type":["string","null"]}},"required":["id","label","description"],"additionalProperties":false},"records":{"type":"array","items":{"type":"object","properties":{"entityType":{"type":"string","enum":["supplier","customer","product","product_family","contact","opportunity","sales_order","purchase_order","ship_to_address","ship_from_address"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string","minLength":1},"externalId":{"type":["string","null"]},"archived":{"type":"boolean"}},"required":["entityType","id","displayName","externalId","archived"],"additionalProperties":false}}},"required":["resolvedTag","records"],"additionalProperties":false},"meta":{"type":"object","properties":{"capabilityKey":{"type":"string","enum":["find_tagged_records"]},"capabilityVersion":{"type":"string","minLength":1},"returnedRecords":{"type":"integer","minimum":0},"populationCount":{"type":["integer","null"],"minimum":0},"complete":{"type":"boolean"},"hasMore":{"type":"boolean"},"nextCursor":{"type":["string","null"]},"ordering":{"type":"string","enum":["display_name_id"]},"currentState":{"type":"boolean","enum":[true]},"snapshotIsolatedAcrossRequests":{"type":"boolean","enum":[false]},"requestId":{"type":"string"},"archivedExcluded":{"type":"boolean"}},"required":["capabilityKey","capabilityVersion","returnedRecords","populationCount","complete","hasMore","nextCursor","ordering","currentState","snapshotIsolatedAcrossRequests","requestId","archivedExcluded"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/product-directory":{"get":{"operationId":"findPublicAPIProductDirectory","summary":"Find products by regulatory identity or name","description":"Returns the certified product and product-family population matching UN/NA number, CAS, hazard class, packing group, or all raw name tokens. nameQueries batches up to 50 printed names, mutually exclusive with nameQuery; rows carry matchedQueries and metadata gives complete per-name counts and unmatched names. Ordinary lookup searches organization names only; supplier names stay in supplier-history. Keep the original filters and limit unchanged, then continue with the exact returned nextCursor value; each page reflects current data when requested","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"products:read","parameters":[{"schema":{"type":"string"},"required":false,"name":"unNumber","in":"query"},{"schema":{"type":"string"},"required":false,"name":"casNumber","in":"query"},{"schema":{"type":"string"},"required":false,"name":"hazardClass","in":"query"},{"schema":{"type":"string"},"required":false,"name":"packingGroup","in":"query"},{"schema":{"type":"string"},"required":false,"name":"nameQuery","in":"query"},{"schema":{"type":"array","items":{"type":"string","minLength":2,"maxLength":120},"minItems":1,"maxItems":50},"required":false,"name":"nameQueries","in":"query"},{"schema":{"type":"string","enum":["true","false"]},"required":false,"name":"includeArchived","in":"query"},{"schema":{"type":"string","format":"uuid"},"required":false,"name":"createdById","in":"query"},{"schema":{"type":"string","format":"date-time"},"required":false,"name":"createdFrom","in":"query"},{"schema":{"type":"string","format":"date-time"},"required":false,"name":"createdTo","in":"query"},{"schema":{"type":"string","pattern":"^\\d+$"},"required":false,"name":"limit","in":"query"},{"schema":{"type":"string","minLength":1,"maxLength":4096},"required":false,"name":"cursor","in":"query"}],"responses":{"200":{"description":"Certified product-directory page and searched identifier spaces.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"entityClass":{"type":"string","enum":["product","product_family"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string","minLength":1},"matchedQueries":{"type":"array","items":{"type":"string"}},"familyName":{"type":["string","null"]},"casNumber":{"type":["string","null"]},"unNumber":{"type":["string","null"]},"properShippingName":{"type":["string","null"]},"hazardClass":{"type":["string","null"]},"packingGroup":{"type":["string","null"]},"matchBasis":{"type":["string","null"],"enum":["sku","family"]},"externalId":{"type":["string","null"]},"archived":{"type":["boolean","null"]},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["user"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["system"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string","enum":["System User"]}},"required":["type","id","displayName"],"additionalProperties":false}]}},"required":["entityClass","id","displayName","familyName","casNumber","unNumber","properShippingName","hazardClass","packingGroup","matchBasis","externalId","archived","createdAt","createdBy"],"additionalProperties":false}},"meta":{"type":"object","properties":{"capabilityKey":{"type":"string","enum":["find_products"]},"capabilityVersion":{"type":"string","minLength":1},"returnedRecords":{"type":"integer","minimum":0},"populationCount":{"type":["integer","null"],"minimum":0},"complete":{"type":"boolean"},"hasMore":{"type":"boolean"},"nextCursor":{"type":["string","null"]},"ordering":{"type":"string","enum":["display_name_entity_type_id"]},"currentState":{"type":"boolean","enum":[true]},"snapshotIsolatedAcrossRequests":{"type":"boolean","enum":[false]},"requestId":{"type":"string"},"nameQueryCounts":{"type":"array","items":{"type":"object","properties":{"query":{"type":"string"},"count":{"type":"integer","minimum":0},"complete":{"type":"boolean"}},"required":["query","count","complete"],"additionalProperties":false}},"unmatchedQueries":{"type":"array","items":{"type":"string"}},"archivedExcluded":{"type":"boolean"},"searchedIdentifierSpaces":{"type":"array","items":{"type":"string","enum":["un_number","cas_number","hazard_class","packing_group","name"]}}},"required":["capabilityKey","capabilityVersion","returnedRecords","populationCount","complete","hasMore","nextCursor","ordering","currentState","snapshotIsolatedAcrossRequests","requestId","archivedExcluded","searchedIdentifierSpaces"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/supplier-history":{"get":{"operationId":"getPublicAPISupplierHistory","summary":"Read supplier product and cost history","description":"Returns the active products connected to each selected supplier through supplier setup, purchasing, or the Cost Book. Include 1 to 25 supplierIds, and optionally narrow the result with up to 50 nameQueries or 200 productIds. Each supplier reports coverage, supplier-specific product names, ship-from locations, recent purchase evidence, saved arrangements, and latest saved costs. Amounts include their currency, unit, and comparison basis. Requires both cost-book-entries:read and suppliers:read plus the acting person's current Cost Book and Supplier access.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"cost-book-entries:read","x-required-scopes-all":["cost-book-entries:read","suppliers:read"],"parameters":[{"schema":{"type":"array","items":{"type":"string","format":"uuid"},"minItems":1,"maxItems":25},"required":true,"name":"supplierIds","in":"query"},{"schema":{"type":"array","items":{"type":"string","format":"uuid"},"minItems":1,"maxItems":200},"required":false,"name":"productIds","in":"query"},{"schema":{"type":"array","items":{"type":"string","minLength":2,"maxLength":120},"minItems":1,"maxItems":50},"required":false,"name":"nameQueries","in":"query"}],"responses":{"200":{"description":"Supplier histories with per-supplier completeness and latest saved costs.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"currencyCode":{"type":"string","minLength":3,"maxLength":3},"timezone":{"type":"string"},"observedAt":{"type":"string"},"limit":{"type":"integer","exclusiveMinimum":0},"suppliers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"products":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"code":{"type":"string"},"name":{"type":["string","null"]},"archived":{"type":"boolean","enum":[false]},"family":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false},"package":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"quantity":{"type":"string"},"uom":{"type":"string"},"type":{"type":"string"}},"required":["id","name","quantity","uom","type"],"additionalProperties":false},"supplierNames":{"type":"array","items":{"type":"string"}},"admittedBy":{"type":"array","items":{"type":"string","enum":["linked","purchased","arrangement"]}},"matchedQueries":{"type":"array","items":{"type":"string"}},"lastCompletedPurchase":{"type":["object","null"],"properties":{"materialCost":{"type":"object","properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string","minLength":3,"maxLength":3},"uom":{"type":"string"},"comparisonBasis":{"type":"string","enum":["material","landed","unclassified"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom","comparisonBasis"],"additionalProperties":false},"landedCost":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string","minLength":3,"maxLength":3},"uom":{"type":"string"},"comparisonBasis":{"type":"string","enum":["material","landed","unclassified"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom","comparisonBasis"],"additionalProperties":false},"sourceDate":{"type":"string"},"observedAt":{"type":"string"},"status":{"type":"string","enum":["completed","pending"]},"sourceReference":{"type":"string"}},"required":["materialCost","landedCost","sourceDate","observedAt","status","sourceReference"],"additionalProperties":false},"latestOnOrderPurchase":{"type":["object","null"],"properties":{"materialCost":{"type":"object","properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string","minLength":3,"maxLength":3},"uom":{"type":"string"},"comparisonBasis":{"type":"string","enum":["material","landed","unclassified"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom","comparisonBasis"],"additionalProperties":false},"landedCost":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string","minLength":3,"maxLength":3},"uom":{"type":"string"},"comparisonBasis":{"type":"string","enum":["material","landed","unclassified"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom","comparisonBasis"],"additionalProperties":false},"sourceDate":{"type":"string"},"observedAt":{"type":"string"},"status":{"type":"string","enum":["completed","pending"]},"sourceReference":{"type":"string"}},"required":["materialCost","landedCost","sourceDate","observedAt","status","sourceReference"],"additionalProperties":false},"arrangements":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"kind":{"type":"string","enum":["GENERAL","AT_PICKUP","AT_DESTINATION"]},"shipFromLocationId":{"type":["string","null"],"format":"uuid"},"destinationCity":{"type":["string","null"]},"destinationState":{"type":["string","null"]},"destinationCountryCode":{"type":["string","null"]},"latestCost":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"starting":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string","minLength":3,"maxLength":3},"uom":{"type":"string"},"comparisonBasis":{"type":"string","enum":["material","landed","unclassified"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom","comparisonBasis"],"additionalProperties":false},"added":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string","minLength":3,"maxLength":3},"uom":{"type":"string"},"comparisonBasis":{"type":"string","enum":["material","landed","unclassified"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom","comparisonBasis"],"additionalProperties":false},"total":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string","minLength":3,"maxLength":3},"uom":{"type":"string"},"comparisonBasis":{"type":"string","enum":["material","landed","unclassified"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom","comparisonBasis"],"additionalProperties":false},"additionalCosts":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"integer"},"class":{"type":"string"},"method":{"type":"string","enum":["percent_of_starting_cost","cents_per_base_uom","cents_per_package"]},"value":{"type":"string"},"description":{"type":["string","null"]},"resolvedContribution":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string","minLength":3,"maxLength":3},"uom":{"type":"string"},"comparisonBasis":{"type":"string","enum":["material","landed","unclassified"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom","comparisonBasis"],"additionalProperties":false}},"required":["sequence","class","method","value","description","resolvedContribution"],"additionalProperties":false}},"rates":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"integer","minimum":0},"amount":{"type":"object","properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string","minLength":3,"maxLength":3},"uom":{"type":"string","minLength":1}},"required":["decimalCentsPerBaseUom","currencyCode","uom"],"additionalProperties":false},"minimumQuantity":{"type":["string","null"]},"minimumBasis":{"type":["string","null"],"enum":["product_uom","package"]},"minimumPackage":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","minLength":1},"quantity":{"type":"string"},"uom":{"type":"string","minLength":1}},"required":["id","name","quantity","uom"],"additionalProperties":false}},"required":["sequence","amount","minimumQuantity","minimumBasis","minimumPackage"],"additionalProperties":false}},"effectiveFrom":{"type":"string"},"effectiveTo":{"type":["string","null"]},"state":{"type":"string"},"note":{"type":["string","null"]},"warningCodes":{"type":"array","items":{"type":"string"}}},"required":["id","starting","added","total","additionalCosts","rates","effectiveFrom","effectiveTo","state","note","warningCodes"],"additionalProperties":false}},"required":["id","name","kind","shipFromLocationId","destinationCity","destinationState","destinationCountryCode","latestCost"],"additionalProperties":false}}},"required":["id","code","name","archived","family","package","supplierNames","admittedBy","matchedQueries","lastCompletedPurchase","latestOnOrderPurchase","arrangements"],"additionalProperties":false}},"shipFromLocations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"city":{"type":["string","null"]},"state":{"type":["string","null"]}},"required":["id","name","city","state"],"additionalProperties":false}},"coverage":{"type":"object","properties":{"complete":{"type":"boolean"},"scope":{"type":"string","enum":["supplier","names","products","names_and_products"]},"returnedProducts":{"type":"integer"},"returnedArrangements":{"type":"integer","minimum":0},"returnedSavedCosts":{"type":"integer","minimum":0},"reason":{"type":["string","null"]}},"required":["complete","scope","returnedProducts","returnedArrangements","returnedSavedCosts","reason"],"additionalProperties":false},"nameQueryCounts":{"type":"array","items":{"type":"object","properties":{"query":{"type":"string"},"count":{"type":"integer"},"complete":{"type":"boolean"}},"required":["query","count","complete"],"additionalProperties":false}},"unmatchedQueries":{"type":"array","items":{"type":"string"}}},"required":["id","name","products","shipFromLocations","coverage","nameQueryCounts","unmatchedQueries"],"additionalProperties":false}}},"required":["currencyCode","timezone","observedAt","limit","suppliers"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/document-uploads":{"post":{"operationId":"createPublicAPIDocumentUploadGrant","summary":"Create a private document upload grant","description":"Creates a 10-minute, single-object PUT grant for one private file up to 15 MiB. Send every returned upload.headers value verbatim to the returned upload.url. A successful S3 PUT has no ShelfCycle JSON envelope. The returned document descriptor can then be submitted to a Product, Customer, or Supplier document route, or to the Product SDS route. The grant does not attach, scan, parse, or make the file public; extension/MIME policy and SHA-256 transfer integrity are verified before a new association. PDF and raster images may be dedicated SDS files; DOCX, XLSX, and PPTX are general attachments only. A valid API-upload descriptor may be passed between keys in the same organization. documents:upload is required only to mint the grant; association and SDS routes require their documented target write scope and current ShelfCycle access. Descriptor possession grants no read access. API-upload association create and replay responses omit signed access unless the calling key also has the target read scope and live view permission.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"documents:upload","x-required-scopes-all":["documents:upload"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"fileName":{"type":"string"},"contentType":{"type":"string"},"sizeBytes":{"type":"number"},"checksumSha256":{"type":"string"}},"required":["fileName","contentType","sizeBytes","checksumSha256"],"additionalProperties":false}}}},"responses":{"201":{"description":"Private document upload grant and reusable document descriptor.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["document_upload_grant"]},"id":{"type":"string","format":"uuid"},"upload":{"type":"object","properties":{"method":{"type":"string","enum":["PUT"]},"url":{"type":"string","format":"uri"},"headers":{"type":"object","properties":{"Content-Length":{"type":"string"},"Content-Type":{"type":"string"},"If-None-Match":{"type":"string","enum":["*"]},"x-amz-checksum-sha256":{"type":"string"}},"required":["Content-Length","Content-Type","If-None-Match","x-amz-checksum-sha256"],"additionalProperties":false},"expiresAt":{"type":"string","format":"date-time"}},"required":["method","url","headers","expiresAt"],"additionalProperties":false},"document":{"type":"object","properties":{"fileName":{"type":"string"},"url":{"type":"string","format":"uri"}},"required":["fileName","url"],"additionalProperties":false}},"required":["type","id","upload","document"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/cost-book-entries/{id}":{"patch":{"operationId":"editPublicAPICostBookEntry","summary":"Correct one Cost Book event while preserving its history","description":"Creates a corrected replacement for the selected Cost Book event while preserving the original event and its supporting history. The correction remains in the same commercial lane. Use dryRun=true to review it before applying with expectedCurrentEntryId and Idempotency-Key.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"cost-book-entries:write","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","enum":["true"]},"required":false,"name":"dryRun","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Required for execute requests. dryRun=true may omit this header and receive an idempotency_key_required check."},"required":false,"description":"Required for execute requests. dryRun=true may omit this header and receive an idempotency_key_required check.","name":"Idempotency-Key","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"expectedCurrentEntryId":{"type":"string","format":"uuid"},"effectiveFrom":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"effectiveTo":{"type":["string","null"],"pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"note":{"type":["string","null"],"maxLength":2000},"sourceRef":{"type":["string","null"],"maxLength":500},"terms":{"type":["string","null"],"maxLength":4000},"incoterm":{"type":["string","null"],"enum":["EXW","FCA","FAS","FOB","CFR","CIF","CPT","CIP","DAP","DPU","DDP","None"]},"construction":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["direct"]},"basis":{"type":"string","enum":["material","landed"]},"uom":{"type":"string","enum":["GALLON","LITER","POUND","KILOGRAM","EACH","METRIC_TON","SHORT_TON"]},"costPerBaseUomCents":{"type":"string"},"rates":{"type":"array","items":{"type":"object","properties":{"costPerBaseUomCents":{"type":"string"},"minimumQuantity":{"type":["string","null"]},"minimumBasis":{"type":["string","null"],"enum":["product_uom","package"]},"minimumProductPackagingId":{"type":["string","null"],"format":"uuid"}},"required":["costPerBaseUomCents"],"additionalProperties":false},"minItems":1,"maxItems":50}},"required":["type","basis","uom"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["constructed"]},"startingCost":{"type":"object","properties":{"source":{"type":"string","enum":["entered"]},"basis":{"type":"string","enum":["material","landed"]},"uom":{"type":"string","enum":["GALLON","LITER","POUND","KILOGRAM","EACH","METRIC_TON","SHORT_TON"]},"costPerBaseUomCents":{"type":"string"}},"required":["source","basis","uom","costPerBaseUomCents"],"additionalProperties":false},"additionalCosts":{"type":"array","items":{"type":"object","properties":{"class":{"type":"string","enum":["FREIGHT","PACKAGING","DUTY","STORAGE","PROCESSING","HANDLING","TAX","OTHER"]},"method":{"type":"string","enum":["percent_of_starting_cost","cents_per_base_uom","cents_per_package"]},"value":{"type":"string"},"description":{"type":["string","null"],"maxLength":500}},"required":["class","method","value"],"additionalProperties":false},"minItems":1,"maxItems":50}},"required":["type","startingCost","additionalCosts"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["constructed"]},"startingCost":{"type":"object","properties":{"source":{"type":"string","enum":["cost_book_entry"]},"productId":{"type":"string","format":"uuid"}},"required":["source","productId"],"additionalProperties":false},"additionalCosts":{"type":"array","items":{"type":"object","properties":{"class":{"type":"string","enum":["FREIGHT","PACKAGING","DUTY","STORAGE","PROCESSING","HANDLING","TAX","OTHER"]},"method":{"type":"string","enum":["percent_of_starting_cost","cents_per_base_uom","cents_per_package"]},"value":{"type":"string"},"description":{"type":["string","null"],"maxLength":500}},"required":["class","method","value"],"additionalProperties":false},"maxItems":50}},"required":["type","startingCost","additionalCosts"],"additionalProperties":false}]}},"required":["expectedCurrentEntryId"],"additionalProperties":false}}}},"responses":{"200":{"description":"Immutable edit receipt, idempotent replay, or dry-run prediction.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["user"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["system"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string","enum":["System User"]}},"required":["type","id","displayName"],"additionalProperties":false}]},"resourceType":{"type":"string","enum":["cost_book_entry"]},"entryType":{"type":"string","enum":["direct","constructed"]},"product":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"code":{"type":"string"},"displayName":{"type":"string"},"archived":{"type":"boolean"},"url":{"type":"string","format":"uri"}},"required":["id","code","displayName","archived","url"],"additionalProperties":false},"supplier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"externalId":{"type":["string","null"]},"archived":{"type":"boolean"},"url":{"type":"string","format":"uri"}},"required":["id","displayName","externalId","archived","url"],"additionalProperties":false},"arrangement":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"kind":{"type":"string","enum":["GENERAL","AT_PICKUP","AT_DESTINATION"]},"isTaught":{"type":"boolean"}},"required":["id","name","kind","isTaught"],"additionalProperties":false},"shipFromLocation":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false},"incoterm":{"type":["string","null"],"enum":["EXW","FCA","FAS","FOB","CFR","CIF","CPT","CIP","DAP","DPU","DDP","None"]},"supplierTerms":{"type":["string","null"]},"rates":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"integer","minimum":0},"amount":{"type":"object","properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string"},"uom":{"type":"string","enum":["GALLON","LITER","POUND","KILOGRAM","EACH","METRIC_TON","SHORT_TON"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom"],"additionalProperties":false},"minimumQuantity":{"type":["string","null"]},"minimumBasis":{"type":["string","null"],"enum":["product_uom","package"]},"minimumPackage":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"quantity":{"type":"string"},"uom":{"type":"string"}},"required":["id","name","quantity","uom"],"additionalProperties":false}},"required":["sequence","amount","minimumQuantity","minimumBasis","minimumPackage"],"additionalProperties":false}},"lineage":{"type":["object","null"],"properties":{"authoredByMode":{"type":["string","null"],"enum":["updateCost","editCost"]},"authoredAt":{"type":["string","null"],"format":"date-time"},"authoredById":{"type":["string","null"],"format":"uuid"},"supersedesEntryId":{"type":["string","null"],"format":"uuid"},"correctsEntryId":{"type":["string","null"],"format":"uuid"},"supersededAt":{"type":["string","null"],"format":"date-time"}},"required":["authoredByMode","authoredAt","authoredById","supersedesEntryId","correctsEntryId","supersededAt"],"additionalProperties":false},"resolutionState":{"type":"string","enum":["resolved","quantity_required","unavailable"]},"effectiveState":{"type":"string","enum":["active","scheduled","expired"]},"versionState":{"type":"string","enum":["current","superseded"]},"claimRole":{"type":"string","enum":["authoritative","supporting","non_authoritative"]},"disposition":{"type":"string","enum":["eligible","dismissed","archived"]},"effectiveFrom":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"effectiveTo":{"type":["string","null"],"pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"construction":{"type":"object","properties":{"type":{"type":"string","enum":["direct","constructed"]},"startingCost":{"anyOf":[{"type":"object","properties":{"source":{"type":"string","enum":["entered"]},"entryId":{"type":["string","null"],"format":"uuid"},"basis":{"type":["string","null"],"enum":["material","landed"]},"amount":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string"},"uom":{"type":"string","enum":["GALLON","LITER","POUND","KILOGRAM","EACH","METRIC_TON","SHORT_TON"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom"],"additionalProperties":false},"provenance":{"type":["object","null"],"properties":{"origin":{"type":"string","enum":["manual","integration","agent","import"]},"sourceRef":{"type":["string","null"]},"verifiedAt":{"type":["string","null"],"format":"date-time"},"verifiedBy":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["id","displayName"],"additionalProperties":false}},"required":["origin","sourceRef","verifiedAt","verifiedBy"],"additionalProperties":false}},"required":["source","entryId","basis","amount","provenance"],"additionalProperties":false},{"type":"object","properties":{"source":{"type":"string","enum":["cost_book_entry"]},"entryId":{"type":["string","null"],"format":"uuid"},"product":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"code":{"type":"string"},"displayName":{"type":"string"},"archived":{"type":"boolean"},"url":{"type":"string","format":"uri"}},"required":["id","code","displayName","archived","url"],"additionalProperties":false},"basis":{"type":["string","null"],"enum":["material","landed"]},"amount":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string"},"uom":{"type":"string","enum":["GALLON","LITER","POUND","KILOGRAM","EACH","METRIC_TON","SHORT_TON"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom"],"additionalProperties":false},"provenance":{"type":["object","null"],"properties":{"origin":{"type":"string","enum":["manual","integration","agent","import"]},"sourceRef":{"type":["string","null"]},"verifiedAt":{"type":["string","null"],"format":"date-time"},"verifiedBy":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["id","displayName"],"additionalProperties":false}},"required":["origin","sourceRef","verifiedAt","verifiedBy"],"additionalProperties":false}},"required":["source","entryId","product","basis","amount","provenance"],"additionalProperties":false}]},"additionalCosts":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"integer","minimum":0},"class":{"type":"string","enum":["FREIGHT","PACKAGING","DUTY","STORAGE","PROCESSING","HANDLING","TAX","OTHER"]},"method":{"type":"string","enum":["percent_of_starting_cost","cents_per_base_uom","cents_per_package"]},"value":{"type":"string"},"description":{"type":["string","null"]},"resolvedContribution":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string"},"uom":{"type":"string","enum":["GALLON","LITER","POUND","KILOGRAM","EACH","METRIC_TON","SHORT_TON"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom"],"additionalProperties":false}},"required":["sequence","class","method","value","description","resolvedContribution"],"additionalProperties":false}}},"required":["type","startingCost","additionalCosts"],"additionalProperties":false},"additionalCostTotal":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string"},"uom":{"type":"string","enum":["GALLON","LITER","POUND","KILOGRAM","EACH","METRIC_TON","SHORT_TON"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom"],"additionalProperties":false},"totalCost":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string"},"uom":{"type":"string","enum":["GALLON","LITER","POUND","KILOGRAM","EACH","METRIC_TON","SHORT_TON"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom"],"additionalProperties":false},"provenance":{"type":"object","properties":{"origin":{"type":"string","enum":["manual","integration","agent","import"]},"sourceRef":{"type":["string","null"]},"verifiedAt":{"type":["string","null"],"format":"date-time"},"verifiedBy":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["id","displayName"],"additionalProperties":false}},"required":["origin","sourceRef","verifiedAt","verifiedBy"],"additionalProperties":false},"completeness":{"type":"object","properties":{"status":{"type":"string","enum":["complete","unresolved"]},"warningCodes":{"type":"array","items":{"type":"string"}}},"required":["status","warningCodes"],"additionalProperties":false},"waitingReason":{"type":"string","description":"Present when a constructed entry has no total because its starting price is not current."},"costBookUrl":{"type":"string","format":"uri"},"idempotencyStatus":{"type":"string","enum":["created","replayed"]},"resultAction":{"type":"string","enum":["created","superseded"]},"warnings":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false}}},"required":["id","createdAt","resourceType","entryType","product","supplier","shipFromLocation","incoterm","supplierTerms","rates","resolutionState","effectiveState","versionState","claimRole","disposition","effectiveFrom","effectiveTo","construction","additionalCostTotal","totalCost","provenance","completeness","costBookUrl","idempotencyStatus","resultAction","warnings"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"status":{"type":"string","enum":["ready"]},"operation":{"type":"string","enum":["editCost"]},"currentEntryId":{"type":["string","null"],"format":"uuid"},"predictedEntry":{"type":["object","null"],"properties":{"entryType":{"type":"string","enum":["direct","constructed"]},"construction":{"type":"object","properties":{"type":{"type":"string","enum":["direct","constructed"]},"startingCost":{"type":"object","properties":{"source":{"type":"string","enum":["entered","cost_book_entry"]},"entryId":{"type":["string","null"],"format":"uuid"},"productId":{"type":["string","null"],"format":"uuid"},"basis":{"type":["string","null"],"enum":["material","landed"]},"amount":{"type":"object","properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string"},"uom":{"type":"string","enum":["GALLON","LITER","POUND","KILOGRAM","EACH","METRIC_TON","SHORT_TON"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom"],"additionalProperties":false}},"required":["source","entryId","productId","basis","amount"],"additionalProperties":false},"additionalCosts":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"integer","minimum":0},"class":{"type":"string","enum":["FREIGHT","PACKAGING","DUTY","STORAGE","PROCESSING","HANDLING","TAX","OTHER"]},"method":{"type":"string","enum":["percent_of_starting_cost","cents_per_base_uom","cents_per_package"]},"value":{"type":"string"},"description":{"type":["string","null"]},"resolvedContribution":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string"},"uom":{"type":"string","enum":["GALLON","LITER","POUND","KILOGRAM","EACH","METRIC_TON","SHORT_TON"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom"],"additionalProperties":false}},"required":["sequence","class","method","value","description","resolvedContribution"],"additionalProperties":false}}},"required":["type","startingCost","additionalCosts"],"additionalProperties":false},"additionalCostTotal":{"type":"object","properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string"},"uom":{"type":"string","enum":["GALLON","LITER","POUND","KILOGRAM","EACH","METRIC_TON","SHORT_TON"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom"],"additionalProperties":false},"totalCost":{"type":"object","properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string"},"uom":{"type":"string","enum":["GALLON","LITER","POUND","KILOGRAM","EACH","METRIC_TON","SHORT_TON"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom"],"additionalProperties":false},"completeness":{"type":"object","properties":{"status":{"type":"string","enum":["complete"]},"warningCodes":{"type":"array","items":{"type":"string"}}},"required":["status","warningCodes"],"additionalProperties":false}},"required":["entryType","construction","additionalCostTotal","totalCost","completeness"],"additionalProperties":false}},"required":["status","operation","currentEntryId","predictedEntry"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}]}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"Cost Book entry was not found or is not visible to this organization.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"409":{"description":"The write conflicted with an existing record, idempotency payload, or stale If-Match value.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deletePublicAPICostBookEntry","summary":"Delete one mistaken Cost Book entry","description":"Removes one selected direct, Landed, or Built from Cost Book entry and its corrections. A ready preview identifies the entry to remove, the preceding version that will return, its added costs, any surviving starting price, and a confirmation sentence. Saved Price Book decisions keep their original figures. Send expectedCurrentEntryId and Idempotency-Key; an exact retry returns the completed receipt.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"cost-book-entries:write","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","enum":["true"]},"required":false,"name":"dryRun","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Required for execute requests. dryRun=true may omit this header and receive an idempotency_key_required check."},"required":false,"description":"Required for execute requests. dryRun=true may omit this header and receive an idempotency_key_required check.","name":"Idempotency-Key","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"expectedCurrentEntryId":{"type":"string","format":"uuid"}},"required":["expectedCurrentEntryId"],"additionalProperties":false}}}},"responses":{"200":{"description":"Removal receipt, exact retry receipt, or preview result.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"resultAction":{"type":"string","enum":["deleted"]},"idempotencyStatus":{"type":"string","enum":["created","replayed"]},"warnings":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false}}},"required":["id","resultAction","idempotencyStatus","warnings"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"status":{"type":"string","enum":["ready"]},"operation":{"type":"string","enum":["deleteCost"]},"currentEntryId":{"type":["string","null"],"format":"uuid"},"predictedEntry":{"type":"null"},"removed":{"type":"object","properties":{"prices":{"type":"array","items":{"type":"string","format":"uuid"}},"breakdowns":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["prices","breakdowns"],"additionalProperties":false},"restored":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"dateFrom":{"type":"string","format":"date-time"},"dateTo":{"type":["string","null"],"format":"date-time"}},"required":["id","dateFrom","dateTo"],"additionalProperties":false}},"addedCostCount":{"type":"integer","minimum":0},"survivingBasePrice":{"type":["object","null"],"properties":{"currencyCode":{"type":"string"},"decimalCentsPerBaseUom":{"type":"string"}},"required":["currencyCode","decimalCentsPerBaseUom"],"additionalProperties":false},"confirmation":{"type":"string"}},"required":["status","operation","currentEntryId","predictedEntry","removed","restored","addedCostCount","survivingBasePrice","confirmation"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}]}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"Cost Book entry was not found or is not visible to this organization.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"409":{"description":"The write conflicted with an existing record, idempotency payload, or stale If-Match value.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/cost-book-entries/batch":{"post":{"operationId":"batchPublicAPICostBookEntries","summary":"Apply up to 50 Cost Book updates or corrections","description":"Applies Cost Book updates and corrections in submitted order. A batch accepts at most 50 items, 500 total rates or components, and 2 MB. Rate limits count each submitted item. Item-level failures do not undo successful items, and an interrupted request can continue pending items when retried with the same key and body.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"cost-book-entries:write","parameters":[{"schema":{"type":"string","enum":["true"]},"required":false,"name":"dryRun","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Required for execute requests. dryRun=true may omit this header and receive an idempotency_key_required check."},"required":false,"description":"Required for execute requests. dryRun=true may omit this header and receive an idempotency_key_required check.","name":"Idempotency-Key","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"clientItemId":{"type":"string","minLength":1,"maxLength":128},"mode":{"type":"string","enum":["updateCost"]},"payload":{"anyOf":[{"type":"object","properties":{"productId":{"type":"string","format":"uuid"},"supplierId":{"type":"string","format":"uuid"},"expectedCurrentEntryId":{"type":["string","null"],"format":"uuid"},"effectiveFrom":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"effectiveTo":{"type":["string","null"],"pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"note":{"type":["string","null"],"maxLength":2000},"sourceRef":{"type":["string","null"],"maxLength":500},"terms":{"type":["string","null"],"maxLength":4000},"arrangementId":{"type":["string","null"],"format":"uuid"},"newArrangement":{"type":["object","null"],"properties":{"name":{"type":"string","minLength":1,"maxLength":160},"kind":{"type":"string","enum":["GENERAL","AT_PICKUP","AT_DESTINATION"]},"shipFromLocationId":{"type":["string","null"],"format":"uuid"},"destinationScope":{"type":["object","null"],"properties":{"countryCode":{"type":["string","null"],"minLength":2,"maxLength":2},"state":{"type":["string","null"],"maxLength":120},"city":{"type":["string","null"],"maxLength":120}},"additionalProperties":false}},"required":["name","kind"],"additionalProperties":false},"shipFromLocationId":{"type":["string","null"],"format":"uuid"},"incoterm":{"type":["string","null"],"enum":["EXW","FCA","FAS","FOB","CFR","CIF","CPT","CIP","DAP","DPU","DDP","None"]},"construction":{"type":"object","properties":{"type":{"type":"string","enum":["direct"]},"basis":{"type":"string","enum":["material","landed"]},"uom":{"type":"string","enum":["GALLON","LITER","POUND","KILOGRAM","EACH","METRIC_TON","SHORT_TON"]},"costPerBaseUomCents":{"type":"string"},"rates":{"type":"array","items":{"type":"object","properties":{"costPerBaseUomCents":{"type":"string"},"minimumQuantity":{"type":["string","null"]},"minimumBasis":{"type":["string","null"],"enum":["product_uom","package"]},"minimumProductPackagingId":{"type":["string","null"],"format":"uuid"}},"required":["costPerBaseUomCents"],"additionalProperties":false},"minItems":1,"maxItems":50}},"required":["type","basis","uom"],"additionalProperties":false}},"required":["productId","supplierId","expectedCurrentEntryId","effectiveFrom","construction"],"additionalProperties":false},{"type":"object","properties":{"productId":{"type":"string","format":"uuid"},"supplierId":{"type":"string","format":"uuid"},"expectedCurrentEntryId":{"type":["string","null"],"format":"uuid"},"effectiveFrom":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"effectiveTo":{"type":["string","null"],"pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"note":{"type":["string","null"],"maxLength":2000},"sourceRef":{"type":["string","null"],"maxLength":500},"terms":{"type":["string","null"],"maxLength":4000},"arrangementId":{"type":["string","null"],"format":"uuid"},"newArrangement":{"type":["object","null"],"properties":{"name":{"type":"string","minLength":1,"maxLength":160},"kind":{"type":"string","enum":["GENERAL","AT_PICKUP","AT_DESTINATION"]},"shipFromLocationId":{"type":["string","null"],"format":"uuid"},"destinationScope":{"type":["object","null"],"properties":{"countryCode":{"type":["string","null"],"minLength":2,"maxLength":2},"state":{"type":["string","null"],"maxLength":120},"city":{"type":["string","null"],"maxLength":120}},"additionalProperties":false}},"required":["name","kind"],"additionalProperties":false},"shipFromLocationId":{"type":["string","null"],"format":"uuid"},"incoterm":{"type":"null"},"construction":{"type":"object","properties":{"type":{"type":"string","enum":["constructed"]},"startingCost":{"type":"object","properties":{"source":{"type":"string","enum":["entered"]},"basis":{"type":"string","enum":["material","landed"]},"uom":{"type":"string","enum":["GALLON","LITER","POUND","KILOGRAM","EACH","METRIC_TON","SHORT_TON"]},"costPerBaseUomCents":{"type":"string"}},"required":["source","basis","uom","costPerBaseUomCents"],"additionalProperties":false},"additionalCosts":{"type":"array","items":{"type":"object","properties":{"class":{"type":"string","enum":["FREIGHT","PACKAGING","DUTY","STORAGE","PROCESSING","HANDLING","TAX","OTHER"]},"method":{"type":"string","enum":["percent_of_starting_cost","cents_per_base_uom","cents_per_package"]},"value":{"type":"string"},"description":{"type":["string","null"],"maxLength":500}},"required":["class","method","value"],"additionalProperties":false},"minItems":1,"maxItems":50}},"required":["type","startingCost","additionalCosts"],"additionalProperties":false}},"required":["productId","supplierId","expectedCurrentEntryId","effectiveFrom","construction"],"additionalProperties":false},{"type":"object","properties":{"productId":{"type":"string","format":"uuid"},"supplierId":{"type":"string","format":"uuid"},"expectedCurrentEntryId":{"type":["string","null"],"format":"uuid"},"effectiveFrom":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"effectiveTo":{"type":["string","null"],"pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"note":{"type":["string","null"],"maxLength":2000},"sourceRef":{"type":["string","null"],"maxLength":500},"terms":{"type":["string","null"],"maxLength":4000},"arrangementId":{"type":["string","null"],"format":"uuid"},"newArrangement":{"type":["object","null"],"properties":{"name":{"type":"string","minLength":1,"maxLength":160},"kind":{"type":"string","enum":["GENERAL","AT_PICKUP","AT_DESTINATION"]},"shipFromLocationId":{"type":["string","null"],"format":"uuid"},"destinationScope":{"type":["object","null"],"properties":{"countryCode":{"type":["string","null"],"minLength":2,"maxLength":2},"state":{"type":["string","null"],"maxLength":120},"city":{"type":["string","null"],"maxLength":120}},"additionalProperties":false}},"required":["name","kind"],"additionalProperties":false},"shipFromLocationId":{"type":["string","null"],"format":"uuid"},"incoterm":{"type":"null"},"construction":{"type":"object","properties":{"type":{"type":"string","enum":["constructed"]},"startingCost":{"type":"object","properties":{"source":{"type":"string","enum":["cost_book_entry"]},"productId":{"type":"string","format":"uuid"}},"required":["source","productId"],"additionalProperties":false},"additionalCosts":{"type":"array","items":{"type":"object","properties":{"class":{"type":"string","enum":["FREIGHT","PACKAGING","DUTY","STORAGE","PROCESSING","HANDLING","TAX","OTHER"]},"method":{"type":"string","enum":["percent_of_starting_cost","cents_per_base_uom","cents_per_package"]},"value":{"type":"string"},"description":{"type":["string","null"],"maxLength":500}},"required":["class","method","value"],"additionalProperties":false},"maxItems":50}},"required":["type","startingCost","additionalCosts"],"additionalProperties":false}},"required":["productId","supplierId","expectedCurrentEntryId","effectiveFrom","construction"],"additionalProperties":false}]}},"required":["clientItemId","mode","payload"],"additionalProperties":false},{"type":"object","properties":{"clientItemId":{"type":"string","minLength":1,"maxLength":128},"mode":{"type":"string","enum":["editCost"]},"payload":{"type":"object","properties":{"expectedCurrentEntryId":{"type":"string","format":"uuid"},"effectiveFrom":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"effectiveTo":{"type":["string","null"],"pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"note":{"type":["string","null"],"maxLength":2000},"sourceRef":{"type":["string","null"],"maxLength":500},"terms":{"type":["string","null"],"maxLength":4000},"incoterm":{"type":["string","null"],"enum":["EXW","FCA","FAS","FOB","CFR","CIF","CPT","CIP","DAP","DPU","DDP","None"]},"construction":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["direct"]},"basis":{"type":"string","enum":["material","landed"]},"uom":{"type":"string","enum":["GALLON","LITER","POUND","KILOGRAM","EACH","METRIC_TON","SHORT_TON"]},"costPerBaseUomCents":{"type":"string"},"rates":{"type":"array","items":{"type":"object","properties":{"costPerBaseUomCents":{"type":"string"},"minimumQuantity":{"type":["string","null"]},"minimumBasis":{"type":["string","null"],"enum":["product_uom","package"]},"minimumProductPackagingId":{"type":["string","null"],"format":"uuid"}},"required":["costPerBaseUomCents"],"additionalProperties":false},"minItems":1,"maxItems":50}},"required":["type","basis","uom"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["constructed"]},"startingCost":{"type":"object","properties":{"source":{"type":"string","enum":["entered"]},"basis":{"type":"string","enum":["material","landed"]},"uom":{"type":"string","enum":["GALLON","LITER","POUND","KILOGRAM","EACH","METRIC_TON","SHORT_TON"]},"costPerBaseUomCents":{"type":"string"}},"required":["source","basis","uom","costPerBaseUomCents"],"additionalProperties":false},"additionalCosts":{"type":"array","items":{"type":"object","properties":{"class":{"type":"string","enum":["FREIGHT","PACKAGING","DUTY","STORAGE","PROCESSING","HANDLING","TAX","OTHER"]},"method":{"type":"string","enum":["percent_of_starting_cost","cents_per_base_uom","cents_per_package"]},"value":{"type":"string"},"description":{"type":["string","null"],"maxLength":500}},"required":["class","method","value"],"additionalProperties":false},"minItems":1,"maxItems":50}},"required":["type","startingCost","additionalCosts"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["constructed"]},"startingCost":{"type":"object","properties":{"source":{"type":"string","enum":["cost_book_entry"]},"productId":{"type":"string","format":"uuid"}},"required":["source","productId"],"additionalProperties":false},"additionalCosts":{"type":"array","items":{"type":"object","properties":{"class":{"type":"string","enum":["FREIGHT","PACKAGING","DUTY","STORAGE","PROCESSING","HANDLING","TAX","OTHER"]},"method":{"type":"string","enum":["percent_of_starting_cost","cents_per_base_uom","cents_per_package"]},"value":{"type":"string"},"description":{"type":["string","null"],"maxLength":500}},"required":["class","method","value"],"additionalProperties":false},"maxItems":50}},"required":["type","startingCost","additionalCosts"],"additionalProperties":false}]},"id":{"type":"string","format":"uuid"}},"required":["expectedCurrentEntryId","id"],"additionalProperties":false}},"required":["clientItemId","mode","payload"],"additionalProperties":false}]},"minItems":1,"maxItems":50}},"required":["items"],"additionalProperties":false}}}},"responses":{"200":{"description":"Ordered batch outcomes, completed replay, or dry-run item readiness.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"data":{"type":"object","properties":{"idempotencyStatus":{"type":"string","enum":["created","replayed"]},"counts":{"type":"object","properties":{"total":{"type":"integer"},"succeeded":{"type":"integer"},"failed":{"type":"integer"}},"required":["total","succeeded","failed"],"additionalProperties":false},"results":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"clientItemId":{"type":"string"},"mode":{"type":"string","enum":["updateCost","editCost"]},"status":{"type":"string","enum":["succeeded"]},"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["user"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["system"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string","enum":["System User"]}},"required":["type","id","displayName"],"additionalProperties":false}]},"resourceType":{"type":"string","enum":["cost_book_entry"]},"entryType":{"type":"string","enum":["direct","constructed"]},"product":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"code":{"type":"string"},"displayName":{"type":"string"},"archived":{"type":"boolean"},"url":{"type":"string","format":"uri"}},"required":["id","code","displayName","archived","url"],"additionalProperties":false},"supplier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"externalId":{"type":["string","null"]},"archived":{"type":"boolean"},"url":{"type":"string","format":"uri"}},"required":["id","displayName","externalId","archived","url"],"additionalProperties":false},"arrangement":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"kind":{"type":"string","enum":["GENERAL","AT_PICKUP","AT_DESTINATION"]},"isTaught":{"type":"boolean"}},"required":["id","name","kind","isTaught"],"additionalProperties":false},"shipFromLocation":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false},"incoterm":{"type":["string","null"],"enum":["EXW","FCA","FAS","FOB","CFR","CIF","CPT","CIP","DAP","DPU","DDP","None"]},"supplierTerms":{"type":["string","null"]},"rates":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"integer","minimum":0},"amount":{"type":"object","properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string"},"uom":{"type":"string","enum":["GALLON","LITER","POUND","KILOGRAM","EACH","METRIC_TON","SHORT_TON"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom"],"additionalProperties":false},"minimumQuantity":{"type":["string","null"]},"minimumBasis":{"type":["string","null"],"enum":["product_uom","package"]},"minimumPackage":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"quantity":{"type":"string"},"uom":{"type":"string"}},"required":["id","name","quantity","uom"],"additionalProperties":false}},"required":["sequence","amount","minimumQuantity","minimumBasis","minimumPackage"],"additionalProperties":false}},"lineage":{"type":["object","null"],"properties":{"authoredByMode":{"type":["string","null"],"enum":["updateCost","editCost"]},"authoredAt":{"type":["string","null"],"format":"date-time"},"authoredById":{"type":["string","null"],"format":"uuid"},"supersedesEntryId":{"type":["string","null"],"format":"uuid"},"correctsEntryId":{"type":["string","null"],"format":"uuid"},"supersededAt":{"type":["string","null"],"format":"date-time"}},"required":["authoredByMode","authoredAt","authoredById","supersedesEntryId","correctsEntryId","supersededAt"],"additionalProperties":false},"resolutionState":{"type":"string","enum":["resolved","quantity_required","unavailable"]},"effectiveState":{"type":"string","enum":["active","scheduled","expired"]},"versionState":{"type":"string","enum":["current","superseded"]},"claimRole":{"type":"string","enum":["authoritative","supporting","non_authoritative"]},"disposition":{"type":"string","enum":["eligible","dismissed","archived"]},"effectiveFrom":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"effectiveTo":{"type":["string","null"],"pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"construction":{"type":"object","properties":{"type":{"type":"string","enum":["direct","constructed"]},"startingCost":{"anyOf":[{"type":"object","properties":{"source":{"type":"string","enum":["entered"]},"entryId":{"type":["string","null"],"format":"uuid"},"basis":{"type":["string","null"],"enum":["material","landed"]},"amount":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string"},"uom":{"type":"string","enum":["GALLON","LITER","POUND","KILOGRAM","EACH","METRIC_TON","SHORT_TON"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom"],"additionalProperties":false},"provenance":{"type":["object","null"],"properties":{"origin":{"type":"string","enum":["manual","integration","agent","import"]},"sourceRef":{"type":["string","null"]},"verifiedAt":{"type":["string","null"],"format":"date-time"},"verifiedBy":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["id","displayName"],"additionalProperties":false}},"required":["origin","sourceRef","verifiedAt","verifiedBy"],"additionalProperties":false}},"required":["source","entryId","basis","amount","provenance"],"additionalProperties":false},{"type":"object","properties":{"source":{"type":"string","enum":["cost_book_entry"]},"entryId":{"type":["string","null"],"format":"uuid"},"product":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"code":{"type":"string"},"displayName":{"type":"string"},"archived":{"type":"boolean"},"url":{"type":"string","format":"uri"}},"required":["id","code","displayName","archived","url"],"additionalProperties":false},"basis":{"type":["string","null"],"enum":["material","landed"]},"amount":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string"},"uom":{"type":"string","enum":["GALLON","LITER","POUND","KILOGRAM","EACH","METRIC_TON","SHORT_TON"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom"],"additionalProperties":false},"provenance":{"type":["object","null"],"properties":{"origin":{"type":"string","enum":["manual","integration","agent","import"]},"sourceRef":{"type":["string","null"]},"verifiedAt":{"type":["string","null"],"format":"date-time"},"verifiedBy":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["id","displayName"],"additionalProperties":false}},"required":["origin","sourceRef","verifiedAt","verifiedBy"],"additionalProperties":false}},"required":["source","entryId","product","basis","amount","provenance"],"additionalProperties":false}]},"additionalCosts":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"integer","minimum":0},"class":{"type":"string","enum":["FREIGHT","PACKAGING","DUTY","STORAGE","PROCESSING","HANDLING","TAX","OTHER"]},"method":{"type":"string","enum":["percent_of_starting_cost","cents_per_base_uom","cents_per_package"]},"value":{"type":"string"},"description":{"type":["string","null"]},"resolvedContribution":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string"},"uom":{"type":"string","enum":["GALLON","LITER","POUND","KILOGRAM","EACH","METRIC_TON","SHORT_TON"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom"],"additionalProperties":false}},"required":["sequence","class","method","value","description","resolvedContribution"],"additionalProperties":false}}},"required":["type","startingCost","additionalCosts"],"additionalProperties":false},"additionalCostTotal":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string"},"uom":{"type":"string","enum":["GALLON","LITER","POUND","KILOGRAM","EACH","METRIC_TON","SHORT_TON"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom"],"additionalProperties":false},"totalCost":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string"},"uom":{"type":"string","enum":["GALLON","LITER","POUND","KILOGRAM","EACH","METRIC_TON","SHORT_TON"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom"],"additionalProperties":false},"provenance":{"type":"object","properties":{"origin":{"type":"string","enum":["manual","integration","agent","import"]},"sourceRef":{"type":["string","null"]},"verifiedAt":{"type":["string","null"],"format":"date-time"},"verifiedBy":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["id","displayName"],"additionalProperties":false}},"required":["origin","sourceRef","verifiedAt","verifiedBy"],"additionalProperties":false},"completeness":{"type":"object","properties":{"status":{"type":"string","enum":["complete","unresolved"]},"warningCodes":{"type":"array","items":{"type":"string"}}},"required":["status","warningCodes"],"additionalProperties":false},"waitingReason":{"type":"string","description":"Present when a constructed entry has no total because its starting price is not current."},"costBookUrl":{"type":"string","format":"uri"},"resultAction":{"type":"string","enum":["created","superseded"]}},"required":["id","createdAt","resourceType","entryType","product","supplier","shipFromLocation","incoterm","supplierTerms","rates","resolutionState","effectiveState","versionState","claimRole","disposition","effectiveFrom","effectiveTo","construction","additionalCostTotal","totalCost","provenance","completeness","costBookUrl","resultAction"],"additionalProperties":false}},"required":["clientItemId","mode","status","data"],"additionalProperties":false},{"type":"object","properties":{"clientItemId":{"type":"string"},"mode":{"type":"string","enum":["updateCost","editCost"]},"status":{"type":"string","enum":["failed"]},"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["clientItemId","mode","status","error"],"additionalProperties":false}]}}},"required":["idempotencyStatus","counts","results"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"dryRun":{"type":"boolean","enum":[true]},"results":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"clientItemId":{"type":"string"},"mode":{"type":"string","enum":["updateCost","editCost"]},"status":{"type":"string","enum":["ready"]},"currentEntryId":{"type":["string","null"],"format":"uuid"}},"required":["clientItemId","mode","status","currentEntryId"],"additionalProperties":false},{"type":"object","properties":{"clientItemId":{"type":"string"},"mode":{"type":"string","enum":["updateCost","editCost"]},"status":{"type":"string","enum":["failed"]},"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["clientItemId","mode","status","error"],"additionalProperties":false}]}}},"required":["dryRun","results"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}]}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested parent or record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"409":{"description":"Idempotency identity conflicts with another payload or is actively claimed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"413":{"description":"Batch body exceeds 2 MB.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Batch envelope, child budget, lane identity, or command validation failed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"Batch processing was interrupted; retry the same identity to resume pending items.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/reports":{"get":{"operationId":"listPublicAPIReports","summary":"List available reports","description":"Returns the report catalog available to the current key and user. Reports require reports:read plus current ShelfCycle access on the acting user; allowedForThisKey tells the caller whether the current key and actor can run each report.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"reports:read","responses":{"200":{"description":"Report catalog.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"reports":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","enum":["sales-summary","purchase-summary","open-sales-orders","ap-aging","payments-received","payments-made","ar-aging","pipeline-summary","customer-invoice-settlement-behavior","customer-credit-exposure","customer-invoice-charges"]},"title":{"type":"string"},"description":{"type":"string"},"params":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"required":{"type":"boolean"},"description":{"type":"string"},"values":{"type":"array","items":{"type":"string"}},"defaultValue":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}}]}},"required":["name","required","description"],"additionalProperties":false}},"dimensions":{"type":"array","items":{"type":"string"}},"measures":{"type":"array","items":{"type":"string"}},"requiredScope":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]},"requiredScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"allowedForThisKey":{"type":"boolean"}},"required":["key","title","description","params","dimensions","measures","requiredScope","allowedForThisKey"],"additionalProperties":false}}},"required":["reports"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/reports/{reportKey}":{"get":{"operationId":"runPublicAPIReport","summary":"Run a report","description":"Runs a read-only report. Money fields are cents-as-string: commercial reports use org base currency, while AR/AP aging keep transaction-currency lanes, signed open balances, credits, due-through and opening amounts. ap-aging requires reports:read AND bills:read; payments-received requires reports:read AND customer-payments:read; payments-made requires reports:read AND supplier-payments:read. Every catalog entry lists all required scopes. sales-summary reconciles to Sales Performance semantics and accepts groupBy values customer, productFamily, productCode, salesOrder, salesPerson, supplier, createdBy, month and dateField values invoiceDate, shipDate, orderDate, and enteredDate; purchase-summary is PO material spend, not cash payments; open-sales-orders returns current open sell value only. customer-invoice-settlement-behavior reports recorded final-settlement timing; customer-credit-exposure reports current posted plus committed exposure; customer-invoice-charges reports matched posted charges and independently matched credits.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"reports:read","parameters":[{"schema":{"type":"string","enum":["sales-summary","purchase-summary","open-sales-orders","ap-aging","payments-received","payments-made","ar-aging","pipeline-summary","customer-invoice-settlement-behavior","customer-credit-exposure","customer-invoice-charges"]},"required":true,"name":"reportKey","in":"path"},{"schema":{"type":"string","enum":["true","false"]},"required":false,"name":"includeOpeningDocuments","in":"query"},{"schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"required":false,"name":"dueBy","in":"query"},{"schema":{"type":"string","format":"uuid"},"required":false,"name":"counterpartyId","in":"query"},{"schema":{"type":"string"},"required":false,"name":"groupBy","in":"query"},{"schema":{"type":"string","enum":["invoiceDate","shipDate","orderDate","enteredDate"]},"required":false,"name":"dateField","in":"query"},{"schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"required":false,"name":"startDate","in":"query"},{"schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"required":false,"name":"endDate","in":"query"},{"schema":{"type":"string"},"required":false,"name":"includeStatuses","in":"query"},{"schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"required":false,"name":"comparisonStartDate","in":"query"},{"schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"required":false,"name":"comparisonEndDate","in":"query"},{"schema":{"type":"string","enum":["new","lost","retained"]},"required":false,"name":"comparisonClassification","in":"query"},{"schema":{"type":"string","enum":["sales","comparisonSales","salesDelta","grossProfit","comparisonGrossProfit","grossProfitDelta","grossMarginDeltaPoints","spend","comparisonSpend","spendDelta","netCents","pastDueInvoiceCents","days90PlusCents","oldestDaysPastDue","totalExposure","overage","utilization","postedExposure","committedExposure","customerName"]},"required":false,"name":"sortBy","in":"query"},{"schema":{"type":"string","enum":["asc","desc"]},"required":false,"name":"sortDirection","in":"query"},{"schema":{"type":"string"},"required":false,"name":"flags","in":"query"},{"schema":{"type":"string","format":"uuid"},"required":false,"name":"customerId","in":"query"},{"schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"required":false,"name":"from","in":"query"},{"schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"required":false,"name":"to","in":"query"},{"schema":{"type":"string","format":"uuid"},"required":false,"name":"costCategoryId","in":"query"},{"schema":{"type":"string","minLength":1,"maxLength":120},"required":false,"name":"query","in":"query"},{"schema":{"type":"string","pattern":"^[A-Z]{3}$"},"required":false,"name":"transactionCurrencyCode","in":"query"},{"schema":{"type":"string","format":"uuid"},"required":false,"name":"salesPersonId","in":"query"},{"schema":{"type":"string","format":"uuid"},"required":false,"name":"productFamilyId","in":"query"},{"schema":{"type":"string","format":"uuid"},"required":false,"name":"supplierId","in":"query"},{"schema":{"type":"string"},"required":false,"name":"productCode","in":"query"},{"schema":{"type":"string","enum":["true","false"]},"required":false,"name":"includeDraft","in":"query"},{"schema":{"type":"string"},"required":false,"name":"status","in":"query"},{"schema":{"type":"string","enum":["customer","supplier"]},"required":false,"name":"aspect","in":"query"},{"schema":{"type":"string"},"required":false,"name":"assignedToId","in":"query"},{"schema":{"type":"string","format":"date-time"},"required":false,"name":"createdFrom","in":"query"},{"schema":{"type":"string","format":"date-time"},"required":false,"name":"createdTo","in":"query"},{"schema":{"type":"string"},"required":false,"name":"limit","in":"query"},{"schema":{"type":"string"},"required":false,"name":"offset","in":"query"}],"responses":{"200":{"description":"Report rows, basis, and pagination metadata.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"data":{"type":"object","properties":{"params":{"type":"object","properties":{"counterpartyId":{"type":["string","null"],"format":"uuid","default":null},"transactionCurrencyCode":{"type":["string","null"],"pattern":"^[A-Z]{3}$","default":null},"dueBy":{"type":["string","null"],"pattern":"^\\d{4}-\\d{2}-\\d{2}$","default":null},"limit":{"type":"integer","minimum":1,"maximum":500,"default":100},"offset":{"type":"integer","minimum":0,"maximum":10000,"default":0},"sortBy":{"type":"string","enum":["netCents","openDocumentCents","pastDueDocumentCents","over365Cents","days90PlusCents","dueByCents","oldestDaysPastDue"],"default":"netCents"},"sortDirection":{"type":"string","enum":["asc","desc"],"default":"desc"}},"additionalProperties":false},"basis":{"type":"object","properties":{"dateBasis":{"type":"string","enum":["current-org-calendar-day"]},"timezone":{"type":"string"},"asOfDate":{"type":"string"},"generatedAt":{"type":"string"},"baseCurrencyCode":{"type":"string"},"accountingCutoverDay":{"type":["string","null"]},"coverageStartDate":{"type":["string","null"]},"historyState":{"type":"string","enum":["certified","preview","unverified_configuration_gap"]},"creditsIncluded":{"type":"boolean"},"currencyLaneNote":{"type":"string","enum":["transaction_currency_lanes"]},"paymentBehaviorBasis":{"type":["object","null"],"properties":{"observation":{"type":"string"},"learningWindow":{"type":"string"},"usualDaysLate":{"type":"string"},"recentDaysLate":{"type":"string"},"averageDaysToPay":{"type":"string"},"lastPaymentDate":{"type":"string"},"olderDueOpenCents":{"type":"string"},"olderDuePaidInWindowCents":{"type":"string"}},"required":["observation","learningWindow","usualDaysLate","recentDaysLate","averageDaysToPay","lastPaymentDate","olderDueOpenCents","olderDuePaidInWindowCents"],"additionalProperties":false},"notes":{"type":"array","items":{"type":"string"}}},"required":["dateBasis","timezone","asOfDate","generatedAt","baseCurrencyCode","accountingCutoverDay","coverageStartDate","historyState","creditsIncluded","currencyLaneNote","paymentBehaviorBasis","notes"],"additionalProperties":false},"rows":{"type":"array","items":{"type":"object","properties":{"transactionCurrencyCode":{"type":"string"},"openDocumentCents":{"type":"string","pattern":"^-?\\d+$"},"openCreditCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"netCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"pastDueDocumentCents":{"type":"string","pattern":"^-?\\d+$"},"currentCents":{"type":"string","pattern":"^-?\\d+$"},"days1To30Cents":{"type":"string","pattern":"^-?\\d+$"},"days31To60Cents":{"type":"string","pattern":"^-?\\d+$"},"days61To90Cents":{"type":"string","pattern":"^-?\\d+$"},"days90PlusCents":{"type":"string","pattern":"^-?\\d+$"},"over365Cents":{"type":"string","pattern":"^-?\\d+$"},"unknownCents":{"type":"string","pattern":"^-?\\d+$"},"dueByCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"openingAmountCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"openingDocumentCount":{"type":"integer","minimum":0},"openDocumentCount":{"type":"integer","minimum":0},"pastDueDocumentCount":{"type":"integer","minimum":0},"unknownDueDocumentCount":{"type":"integer","minimum":0},"openCreditCount":{"type":["integer","null"],"minimum":0},"counterpartyId":{"type":"string","format":"uuid"},"counterpartyName":{"type":"string"},"counterpartyStatus":{"type":"string","enum":["active","prospect","archived"]},"oldestDueDate":{"type":["string","null"]},"oldestDaysPastDue":{"type":["integer","null"],"minimum":0},"paymentBehavior":{"type":["object","null"],"properties":{"lastPaymentDate":{"type":["string","null"]},"usualDaysLate":{"type":["number","null"],"description":"Median final cash day minus due day across eligible documents in the learning window."},"recentDaysLate":{"type":["number","null"],"description":"Median final cash day minus due day across eligible documents settled in the last 90 days within that window."},"averageDaysToPay":{"type":["number","null"],"description":"Arithmetic mean final cash day minus document day across eligible documents in the learning window."},"nativePaidDocumentCount":{"type":"integer"},"settledOtherwiseCount":{"type":"integer"},"olderDueOpenCents":{"type":"string"},"olderDuePaidInWindowCents":{"type":["string","null"]},"olderDueCreditInWindowCents":{"type":["string","null"]},"olderDueAdjustmentInWindowCents":{"type":["string","null"]},"cashUnavailableCount":{"type":"integer"},"crossCurrencyCashCount":{"type":"integer"},"coverageStartDate":{"type":["string","null"]},"cashUnavailableReason":{"type":["string","null"],"enum":["legacy_mixed_cash_and_credit","mixed_cash_and_credit_attribution_unrecorded","cross_currency_cash"]}},"required":["lastPaymentDate","usualDaysLate","recentDaysLate","averageDaysToPay","nativePaidDocumentCount","settledOtherwiseCount","olderDueOpenCents","olderDuePaidInWindowCents","olderDueCreditInWindowCents","olderDueAdjustmentInWindowCents","cashUnavailableCount","crossCurrencyCashCount","coverageStartDate","cashUnavailableReason"],"additionalProperties":false}},"required":["transactionCurrencyCode","openDocumentCents","openCreditCents","netCents","pastDueDocumentCents","currentCents","days1To30Cents","days31To60Cents","days61To90Cents","days90PlusCents","over365Cents","unknownCents","dueByCents","openingAmountCents","openingDocumentCount","openDocumentCount","pastDueDocumentCount","unknownDueDocumentCount","openCreditCount","counterpartyId","counterpartyName","counterpartyStatus","oldestDueDate","oldestDaysPastDue","paymentBehavior"],"additionalProperties":false}},"totals":{"type":"object","properties":{"scope":{"type":"string","enum":["filtered-population-before-pagination"]},"byTransactionCurrency":{"type":"array","items":{"type":"object","properties":{"transactionCurrencyCode":{"type":"string"},"openDocumentCents":{"type":"string","pattern":"^-?\\d+$"},"openCreditCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"netCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"pastDueDocumentCents":{"type":"string","pattern":"^-?\\d+$"},"currentCents":{"type":"string","pattern":"^-?\\d+$"},"days1To30Cents":{"type":"string","pattern":"^-?\\d+$"},"days31To60Cents":{"type":"string","pattern":"^-?\\d+$"},"days61To90Cents":{"type":"string","pattern":"^-?\\d+$"},"days90PlusCents":{"type":"string","pattern":"^-?\\d+$"},"over365Cents":{"type":"string","pattern":"^-?\\d+$"},"unknownCents":{"type":"string","pattern":"^-?\\d+$"},"dueByCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"openingAmountCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"openingDocumentCount":{"type":"integer","minimum":0},"openDocumentCount":{"type":"integer","minimum":0},"pastDueDocumentCount":{"type":"integer","minimum":0},"unknownDueDocumentCount":{"type":"integer","minimum":0},"openCreditCount":{"type":["integer","null"],"minimum":0}},"required":["transactionCurrencyCode","openDocumentCents","openCreditCents","netCents","pastDueDocumentCents","currentCents","days1To30Cents","days31To60Cents","days61To90Cents","days90PlusCents","over365Cents","unknownCents","dueByCents","openingAmountCents","openingDocumentCount","openDocumentCount","pastDueDocumentCount","unknownDueDocumentCount","openCreditCount"],"additionalProperties":false}},"baseCurrencyCode":{"type":"string"},"baseOpenDocumentCents":{"type":"string","pattern":"^-?\\d+$"},"baseOpenCreditCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"baseNetCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"openingBaseAmountCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"openingDocumentCount":{"type":"integer","minimum":0}},"required":["scope","byTransactionCurrency","baseCurrencyCode","baseOpenDocumentCents","baseOpenCreditCents","baseNetCents","openingBaseAmountCents","openingDocumentCount"],"additionalProperties":false},"drafts":{"type":"object","properties":{"count":{"type":"integer","minimum":0},"byTransactionCurrency":{"type":"array","items":{"type":"object","properties":{"transactionCurrencyCode":{"type":"string"},"count":{"type":"integer","minimum":0},"amountCents":{"type":"string","pattern":"^-?\\d+$"}},"required":["transactionCurrencyCode","count","amountCents"],"additionalProperties":false}}},"required":["count","byTransactionCurrency"],"additionalProperties":false},"paymentsBeingPrepared":{"type":["object","null"],"properties":{"scope":{"type":"string","enum":["organization","supplier"]},"batchCount":{"type":"integer","minimum":0},"oldestCreatedDate":{"type":["string","null"]},"byTransactionCurrency":{"type":"array","items":{"type":"object","properties":{"transactionCurrencyCode":{"type":"string"},"count":{"type":"integer","minimum":0},"amountCents":{"type":"string","pattern":"^-?\\d+$"}},"required":["transactionCurrencyCode","count","amountCents"],"additionalProperties":false}}},"required":["scope","batchCount","oldestCreatedDate","byTransactionCurrency"],"additionalProperties":false},"hygieneFacts":{"type":"array","items":{"type":"object","properties":{"counterpartyStatus":{"type":"string","enum":["archived","prospect"]},"transactionCurrencyCode":{"type":"string"},"counterpartyCount":{"type":"integer","minimum":0},"openDocumentCents":{"type":"string","pattern":"^-?\\d+$"}},"required":["counterpartyStatus","transactionCurrencyCode","counterpartyCount","openDocumentCents"],"additionalProperties":false}},"meta":{"type":"object","properties":{"totalGroups":{"type":"integer","minimum":0},"returnedGroups":{"type":"integer","minimum":0},"truncated":{"type":"boolean"},"limit":{"type":"integer","minimum":0},"offset":{"type":"integer","minimum":0},"ordering":{"type":"string"},"rankingComplete":{"type":"boolean","enum":[true]},"populationDiagnostics":{"type":"object","properties":{"negativeDueCount":{"type":"integer","minimum":0},"paidWithDueCount":{"type":"integer","minimum":0},"postedZeroDueCount":{"type":"integer","minimum":0},"creditIncoherentCount":{"type":["integer","null"],"minimum":0},"zeroPaidPartialCount":{"type":"integer","minimum":0}},"required":["negativeDueCount","paidWithDueCount","postedZeroDueCount","creditIncoherentCount","zeroPaidPartialCount"],"additionalProperties":false}},"required":["totalGroups","returnedGroups","truncated","limit","offset","ordering","rankingComplete","populationDiagnostics"],"additionalProperties":false},"report":{"type":"object","properties":{"key":{"type":"string","enum":["ap-aging"]},"title":{"type":"string"},"description":{"type":"string"},"params":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"required":{"type":"boolean"},"description":{"type":"string"},"values":{"type":"array","items":{"type":"string"}},"defaultValue":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}}]}},"required":["name","required","description"],"additionalProperties":false}},"dimensions":{"type":"array","items":{"type":"string"}},"measures":{"type":"array","items":{"type":"string"}},"requiredScope":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]},"requiredScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"allowedForThisKey":{"type":"boolean"}},"required":["key","title","description","params","dimensions","measures","requiredScope","allowedForThisKey"],"additionalProperties":false}},"required":["params","basis","rows","totals","drafts","paymentsBeingPrepared","hygieneFacts","meta","report"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"params":{"type":"object","properties":{"from":{"type":["string","null"],"pattern":"^\\d{4}-\\d{2}-\\d{2}$","default":null},"to":{"type":["string","null"],"pattern":"^\\d{4}-\\d{2}-\\d{2}$","default":null},"includeOpeningDocuments":{"type":"boolean","default":false},"counterpartyId":{"type":["string","null"],"format":"uuid","default":null},"transactionCurrencyCode":{"type":["string","null"],"pattern":"^[A-Z]{3}$","default":null},"groupBy":{"type":"string","enum":["counterparty","month"],"default":"counterparty"},"limit":{"type":"integer","minimum":1,"maximum":500,"default":100},"offset":{"type":"integer","minimum":0,"maximum":10000,"default":0}},"additionalProperties":false},"basis":{"type":"object","properties":{"timezone":{"type":"string"},"baseCurrencyCode":{"type":"string"},"accountingCutoverDay":{"type":["string","null"]},"coverageStartDate":{"type":["string","null"]},"effectiveWindow":{"type":"object","properties":{"from":{"type":"string"},"to":{"type":"string"}},"required":["from","to"],"additionalProperties":false},"dateBasis":{"type":"string","enum":["payment date","posted batch date"]},"documentDateBasis":{"type":"string","enum":["posted date"]},"documentAmountsIncluded":{"type":"boolean"},"currencyLaneNote":{"type":"string","enum":["transaction_currency_lanes"]},"historyState":{"type":"string","enum":["certified","preview","unverified_configuration_gap"]}},"required":["timezone","baseCurrencyCode","accountingCutoverDay","coverageStartDate","effectiveWindow","dateBasis","documentDateBasis","documentAmountsIncluded","currencyLaneNote","historyState"],"additionalProperties":false},"rows":{"type":"array","items":{"type":"object","properties":{"transactionCurrencyCode":{"type":"string"},"paymentCount":{"type":"integer"},"cashAmountCents":{"type":"string","pattern":"^-?\\d+$"},"adjustmentCents":{"type":"string","pattern":"^-?\\d+$"},"documentCount":{"type":["integer","null"]},"documentAmountCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"keptOnAccountCents":{"type":"string","pattern":"^-?\\d+$"},"appliedAmountCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"unavailableAllocationCount":{"type":["integer","null"]},"appliedAmountUnavailableReason":{"type":["string","null"],"enum":["allocation_cash_unproven","invoice_permission_withheld"]},"counterpartyId":{"type":["string","null"],"format":"uuid"},"counterpartyName":{"type":["string","null"]},"counterpartyStatus":{"type":["string","null"]},"month":{"type":["string","null"]}},"required":["transactionCurrencyCode","paymentCount","cashAmountCents","adjustmentCents","documentCount","documentAmountCents","keptOnAccountCents","appliedAmountCents","unavailableAllocationCount","appliedAmountUnavailableReason","counterpartyId","counterpartyName","counterpartyStatus","month"],"additionalProperties":false}},"totals":{"type":"object","properties":{"scope":{"type":"string","enum":["filtered-population-before-pagination"]},"byTransactionCurrency":{"type":"array","items":{"type":"object","properties":{"transactionCurrencyCode":{"type":"string"},"paymentCount":{"type":"integer"},"cashAmountCents":{"type":"string","pattern":"^-?\\d+$"},"adjustmentCents":{"type":"string","pattern":"^-?\\d+$"},"documentCount":{"type":["integer","null"]},"documentAmountCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"keptOnAccountCents":{"type":"string","pattern":"^-?\\d+$"},"appliedAmountCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"unavailableAllocationCount":{"type":["integer","null"]},"appliedAmountUnavailableReason":{"type":["string","null"],"enum":["allocation_cash_unproven","invoice_permission_withheld"]}},"required":["transactionCurrencyCode","paymentCount","cashAmountCents","adjustmentCents","documentCount","documentAmountCents","keptOnAccountCents","appliedAmountCents","unavailableAllocationCount","appliedAmountUnavailableReason"],"additionalProperties":false}},"baseCurrencyCode":{"type":"string"},"baseCashAmountCents":{"type":"string","pattern":"^-?\\d+$"},"paymentCount":{"type":"integer"}},"required":["scope","byTransactionCurrency","baseCurrencyCode","baseCashAmountCents","paymentCount"],"additionalProperties":false},"meta":{"type":"object","properties":{"totalGroups":{"type":"integer"},"returnedGroups":{"type":"integer"},"truncated":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"ordering":{"type":"string"},"rankingComplete":{"type":"boolean","enum":[true]}},"required":["totalGroups","returnedGroups","truncated","limit","offset","ordering","rankingComplete"],"additionalProperties":false},"report":{"type":"object","properties":{"key":{"type":"string","enum":["payments-received"]},"title":{"type":"string"},"description":{"type":"string"},"params":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"required":{"type":"boolean"},"description":{"type":"string"},"values":{"type":"array","items":{"type":"string"}},"defaultValue":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}}]}},"required":["name","required","description"],"additionalProperties":false}},"dimensions":{"type":"array","items":{"type":"string"}},"measures":{"type":"array","items":{"type":"string"}},"requiredScope":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]},"requiredScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"allowedForThisKey":{"type":"boolean"}},"required":["key","title","description","params","dimensions","measures","requiredScope","allowedForThisKey"],"additionalProperties":false}},"required":["params","basis","rows","totals","meta","report"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"params":{"type":"object","properties":{"from":{"type":["string","null"],"pattern":"^\\d{4}-\\d{2}-\\d{2}$","default":null},"to":{"type":["string","null"],"pattern":"^\\d{4}-\\d{2}-\\d{2}$","default":null},"includeOpeningDocuments":{"type":"boolean","default":false},"counterpartyId":{"type":["string","null"],"format":"uuid","default":null},"transactionCurrencyCode":{"type":["string","null"],"pattern":"^[A-Z]{3}$","default":null},"groupBy":{"type":"string","enum":["counterparty","month"],"default":"counterparty"},"limit":{"type":"integer","minimum":1,"maximum":500,"default":100},"offset":{"type":"integer","minimum":0,"maximum":10000,"default":0}},"additionalProperties":false},"basis":{"type":"object","properties":{"timezone":{"type":"string"},"baseCurrencyCode":{"type":"string"},"accountingCutoverDay":{"type":["string","null"]},"coverageStartDate":{"type":["string","null"]},"effectiveWindow":{"type":"object","properties":{"from":{"type":"string"},"to":{"type":"string"}},"required":["from","to"],"additionalProperties":false},"dateBasis":{"type":"string","enum":["payment date","posted batch date"]},"documentDateBasis":{"type":"string","enum":["posted date"]},"documentAmountsIncluded":{"type":"boolean"},"currencyLaneNote":{"type":"string","enum":["transaction_currency_lanes"]},"historyState":{"type":"string","enum":["certified","preview","unverified_configuration_gap"]}},"required":["timezone","baseCurrencyCode","accountingCutoverDay","coverageStartDate","effectiveWindow","dateBasis","documentDateBasis","documentAmountsIncluded","currencyLaneNote","historyState"],"additionalProperties":false},"rows":{"type":"array","items":{"type":"object","properties":{"transactionCurrencyCode":{"type":"string"},"paymentCount":{"type":"integer"},"cashAmountCents":{"type":"string","pattern":"^-?\\d+$"},"adjustmentCents":{"type":"string","pattern":"^-?\\d+$"},"documentCount":{"type":["integer","null"]},"documentAmountCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"counterpartyId":{"type":["string","null"],"format":"uuid"},"counterpartyName":{"type":["string","null"]},"counterpartyStatus":{"type":["string","null"]},"month":{"type":["string","null"]}},"required":["transactionCurrencyCode","paymentCount","cashAmountCents","adjustmentCents","documentCount","documentAmountCents","counterpartyId","counterpartyName","counterpartyStatus","month"],"additionalProperties":false}},"totals":{"type":"object","properties":{"scope":{"type":"string","enum":["filtered-population-before-pagination"]},"byTransactionCurrency":{"type":"array","items":{"type":"object","properties":{"transactionCurrencyCode":{"type":"string"},"paymentCount":{"type":"integer"},"cashAmountCents":{"type":"string","pattern":"^-?\\d+$"},"adjustmentCents":{"type":"string","pattern":"^-?\\d+$"},"documentCount":{"type":["integer","null"]},"documentAmountCents":{"type":["string","null"],"pattern":"^-?\\d+$"}},"required":["transactionCurrencyCode","paymentCount","cashAmountCents","adjustmentCents","documentCount","documentAmountCents"],"additionalProperties":false}},"baseCurrencyCode":{"type":"string"},"baseCashAmountCents":{"type":"string","pattern":"^-?\\d+$"},"paymentCount":{"type":"integer"}},"required":["scope","byTransactionCurrency","baseCurrencyCode","baseCashAmountCents","paymentCount"],"additionalProperties":false},"meta":{"type":"object","properties":{"totalGroups":{"type":"integer"},"returnedGroups":{"type":"integer"},"truncated":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"ordering":{"type":"string"},"rankingComplete":{"type":"boolean","enum":[true]}},"required":["totalGroups","returnedGroups","truncated","limit","offset","ordering","rankingComplete"],"additionalProperties":false},"report":{"type":"object","properties":{"key":{"type":"string","enum":["payments-made"]},"title":{"type":"string"},"description":{"type":"string"},"params":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"required":{"type":"boolean"},"description":{"type":"string"},"values":{"type":"array","items":{"type":"string"}},"defaultValue":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}}]}},"required":["name","required","description"],"additionalProperties":false}},"dimensions":{"type":"array","items":{"type":"string"}},"measures":{"type":"array","items":{"type":"string"}},"requiredScope":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]},"requiredScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"allowedForThisKey":{"type":"boolean"}},"required":["key","title","description","params","dimensions","measures","requiredScope","allowedForThisKey"],"additionalProperties":false}},"required":["params","basis","rows","totals","meta","report"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"report":{"type":"object","properties":{"key":{"type":"string","enum":["sales-summary"]},"title":{"type":"string"},"description":{"type":"string"},"params":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"required":{"type":"boolean"},"description":{"type":"string"},"values":{"type":"array","items":{"type":"string"}},"defaultValue":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}}]}},"required":["name","required","description"],"additionalProperties":false}},"dimensions":{"type":"array","items":{"type":"string"}},"measures":{"type":"array","items":{"type":"string"}},"requiredScope":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]},"requiredScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"allowedForThisKey":{"type":"boolean"}},"required":["key","title","description","params","dimensions","measures","requiredScope","allowedForThisKey"],"additionalProperties":false},"params":{"type":"object","additionalProperties":{}},"basis":{"type":"object","properties":{"dateBasis":{"type":"string"},"timezone":{"type":"string"},"currencyMode":{"type":"string","enum":["org-base"]},"generatedAt":{"type":"string","format":"date-time"},"startDate":{"type":"string"},"endDate":{"type":"string"},"statusesRequested":{"type":"array","items":{"type":"string"}},"statusesEffective":{"type":"array","items":{"type":"string"}},"lineType":{"type":"string"},"rowsConsidered":{"type":"integer"},"fetchWindow":{"type":"object","properties":{"start":{"type":["string","null"]},"end":{"type":["string","null"]}},"required":["start","end"],"additionalProperties":false},"largeWindow":{"type":"boolean"},"primaryWindow":{"type":"object","properties":{"startDate":{"type":"string"},"endDate":{"type":"string"},"rowsConsidered":{"type":"integer"}},"required":["startDate","endDate","rowsConsidered"],"additionalProperties":false},"comparisonWindow":{"type":"object","properties":{"startDate":{"type":"string"},"endDate":{"type":"string"},"rowsConsidered":{"type":"integer"}},"required":["startDate","endDate","rowsConsidered"],"additionalProperties":false},"notes":{"type":"array","items":{"type":"string"}}},"required":["dateBasis","timezone","currencyMode","generatedAt","notes"],"additionalProperties":false},"rows":{"type":"array","items":{"type":"object","properties":{"groupId":{"type":["string","null"],"format":"uuid"},"bucketKey":{"type":"string"},"groupName":{"type":"string"},"group2Id":{"type":["string","null"],"format":"uuid"},"group2Key":{"type":"string"},"group2Name":{"type":"string"},"salesCents":{"type":"string"},"productCostCents":{"type":"string"},"orderCostsCents":{"type":"string","description":"Fulfillment cost allocated to the group, in org-base cents as a decimal string, net of recovered pass-through. Product rows carry residual burden after mapped charge recovery; charge rows carry consumed recovery for their class (unmapped charges carry 0). Governed by the organization's live fulfillment mappings."},"totalCostCents":{"type":"string"},"gpCents":{"type":"string","description":"Gross profit in org-base cents as a decimal string: salesCents minus totalCostCents. totalCostCents uses net-of-recovery orderCostsCents, so gpCents is delivered margin at row grain and still sums to the order total when every marginable line is in the window."},"gpPct":{"type":["number","null"],"description":"Gross profit percent from returned cents. Null when salesCents <= 0. Charge-line groups do not expose a margin percent; product-row percent is residual burden over product revenue, which can differ from order-level GP % of invoice total until those denominators are unified."},"qty":{"type":"number"},"volumeLbs":{"type":["number","null"]},"orderCount":{"type":"integer"},"itemCount":{"type":"integer"},"firstDate":{"type":["string","null"]},"lastDate":{"type":["string","null"]},"unitPrice":{"type":"object","properties":{"avgUnitPriceCents":{"type":"string"},"lastUnitPriceCents":{"type":["string","null"]},"uom":{"type":"string"}},"required":["avgUnitPriceCents","lastUnitPriceCents","uom"],"additionalProperties":false},"comparison":{"type":"object","properties":{"salesCents":{"type":"string"},"productCostCents":{"type":"string"},"orderCostsCents":{"type":"string","description":"Fulfillment cost allocated to the group, in org-base cents as a decimal string, net of recovered pass-through. Product rows carry residual burden after mapped charge recovery; charge rows carry consumed recovery for their class (unmapped charges carry 0). Governed by the organization's live fulfillment mappings."},"totalCostCents":{"type":"string"},"gpCents":{"type":"string","description":"Gross profit in org-base cents as a decimal string: salesCents minus totalCostCents. totalCostCents uses net-of-recovery orderCostsCents, so gpCents is delivered margin at row grain and still sums to the order total when every marginable line is in the window."},"gpPct":{"type":["number","null"],"description":"Gross profit percent from returned cents. Null when salesCents <= 0. Charge-line groups do not expose a margin percent; product-row percent is residual burden over product revenue, which can differ from order-level GP % of invoice total until those denominators are unified."},"qty":{"type":"number"},"volumeLbs":{"type":["number","null"]},"orderCount":{"type":"integer"},"itemCount":{"type":"integer"},"firstDate":{"type":["string","null"]},"lastDate":{"type":["string","null"]}},"required":["salesCents","productCostCents","orderCostsCents","totalCostCents","gpCents","gpPct","qty","volumeLbs","orderCount","itemCount","firstDate","lastDate"],"additionalProperties":false},"deltas":{"type":"object","properties":{"salesCents":{"type":"string"},"productCostCents":{"type":"string"},"orderCostsCents":{"type":"string","description":"Fulfillment cost allocated to the group, in org-base cents as a decimal string, net of recovered pass-through. Product rows carry residual burden after mapped charge recovery; charge rows carry consumed recovery for their class (unmapped charges carry 0). Governed by the organization's live fulfillment mappings."},"totalCostCents":{"type":"string"},"gpCents":{"type":"string","description":"Gross profit in org-base cents as a decimal string: salesCents minus totalCostCents. totalCostCents uses net-of-recovery orderCostsCents, so gpCents is delivered margin at row grain and still sums to the order total when every marginable line is in the window."},"qty":{"type":"number"},"volumeLbs":{"type":["number","null"]},"orderCount":{"type":"integer"},"itemCount":{"type":"integer"},"gpPctPoints":{"type":["number","null"]}},"required":["salesCents","productCostCents","orderCostsCents","totalCostCents","gpCents","qty","volumeLbs","orderCount","itemCount","gpPctPoints"],"additionalProperties":false},"comparisonClassification":{"type":"string","enum":["new","lost","retained"]}},"required":["groupId","bucketKey","groupName","salesCents","productCostCents","orderCostsCents","totalCostCents","gpCents","gpPct","qty","volumeLbs","orderCount","itemCount","firstDate","lastDate"],"additionalProperties":false}},"totals":{"type":"object","properties":{"scope":{"type":"string","enum":["filtered-population-before-pagination"]},"primary":{"type":"object","properties":{"salesCents":{"type":"string"},"productCostCents":{"type":"string"},"orderCostsCents":{"type":"string","description":"Fulfillment cost allocated to the group, in org-base cents as a decimal string, net of recovered pass-through. Product rows carry residual burden after mapped charge recovery; charge rows carry consumed recovery for their class (unmapped charges carry 0). Governed by the organization's live fulfillment mappings."},"totalCostCents":{"type":"string"},"gpCents":{"type":"string","description":"Gross profit in org-base cents as a decimal string: salesCents minus totalCostCents. totalCostCents uses net-of-recovery orderCostsCents, so gpCents is delivered margin at row grain and still sums to the order total when every marginable line is in the window."},"gpPct":{"type":["number","null"],"description":"Gross profit percent from returned cents. Null when salesCents <= 0. Charge-line groups do not expose a margin percent; product-row percent is residual burden over product revenue, which can differ from order-level GP % of invoice total until those denominators are unified."},"qty":{"type":"number"},"volumeLbs":{"type":["number","null"]},"itemCount":{"type":"integer"}},"required":["salesCents","productCostCents","orderCostsCents","totalCostCents","gpCents","gpPct","qty","volumeLbs","itemCount"],"additionalProperties":false},"comparison":{"type":"object","properties":{"salesCents":{"type":"string"},"productCostCents":{"type":"string"},"orderCostsCents":{"type":"string","description":"Fulfillment cost allocated to the group, in org-base cents as a decimal string, net of recovered pass-through. Product rows carry residual burden after mapped charge recovery; charge rows carry consumed recovery for their class (unmapped charges carry 0). Governed by the organization's live fulfillment mappings."},"totalCostCents":{"type":"string"},"gpCents":{"type":"string","description":"Gross profit in org-base cents as a decimal string: salesCents minus totalCostCents. totalCostCents uses net-of-recovery orderCostsCents, so gpCents is delivered margin at row grain and still sums to the order total when every marginable line is in the window."},"gpPct":{"type":["number","null"],"description":"Gross profit percent from returned cents. Null when salesCents <= 0. Charge-line groups do not expose a margin percent; product-row percent is residual burden over product revenue, which can differ from order-level GP % of invoice total until those denominators are unified."},"qty":{"type":"number"},"volumeLbs":{"type":["number","null"]},"itemCount":{"type":"integer"}},"required":["salesCents","productCostCents","orderCostsCents","totalCostCents","gpCents","gpPct","qty","volumeLbs","itemCount"],"additionalProperties":false},"deltas":{"type":"object","properties":{"salesCents":{"type":"string"},"productCostCents":{"type":"string"},"orderCostsCents":{"type":"string","description":"Fulfillment cost allocated to the group, in org-base cents as a decimal string, net of recovered pass-through. Product rows carry residual burden after mapped charge recovery; charge rows carry consumed recovery for their class (unmapped charges carry 0). Governed by the organization's live fulfillment mappings."},"totalCostCents":{"type":"string"},"gpCents":{"type":"string","description":"Gross profit in org-base cents as a decimal string: salesCents minus totalCostCents. totalCostCents uses net-of-recovery orderCostsCents, so gpCents is delivered margin at row grain and still sums to the order total when every marginable line is in the window."},"qty":{"type":"number"},"volumeLbs":{"type":["number","null"]},"itemCount":{"type":"integer"},"gpPctPoints":{"type":["number","null"]}},"required":["salesCents","productCostCents","orderCostsCents","totalCostCents","gpCents","qty","volumeLbs","itemCount","gpPctPoints"],"additionalProperties":false}},"required":["scope","primary"],"additionalProperties":false},"meta":{"type":"object","properties":{"totalGroups":{"type":"integer"},"returnedGroups":{"type":"integer"},"truncated":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"ordering":{"type":"string"},"hasMoreAfterPage":{"type":"boolean"},"rowsCoverFullPopulation":{"type":"boolean"},"rankingComplete":{"type":"boolean"},"sortBy":{"type":"string"},"sortDirection":{"type":"string","enum":["asc","desc"]}},"required":["totalGroups","returnedGroups","truncated","limit","offset","ordering","rowsCoverFullPopulation","rankingComplete"],"additionalProperties":false}},"required":["report","params","basis","rows","totals","meta"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"report":{"type":"object","properties":{"key":{"type":"string","enum":["purchase-summary"]},"title":{"type":"string"},"description":{"type":"string"},"params":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"required":{"type":"boolean"},"description":{"type":"string"},"values":{"type":"array","items":{"type":"string"}},"defaultValue":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}}]}},"required":["name","required","description"],"additionalProperties":false}},"dimensions":{"type":"array","items":{"type":"string"}},"measures":{"type":"array","items":{"type":"string"}},"requiredScope":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]},"requiredScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"allowedForThisKey":{"type":"boolean"}},"required":["key","title","description","params","dimensions","measures","requiredScope","allowedForThisKey"],"additionalProperties":false},"params":{"type":"object","additionalProperties":{}},"basis":{"type":"object","properties":{"dateBasis":{"type":"string"},"timezone":{"type":"string"},"currencyMode":{"type":"string","enum":["org-base"]},"generatedAt":{"type":"string","format":"date-time"},"startDate":{"type":"string"},"endDate":{"type":"string"},"statusesRequested":{"type":"array","items":{"type":"string"}},"statusesEffective":{"type":"array","items":{"type":"string"}},"lineType":{"type":"string"},"rowsConsidered":{"type":"integer"},"fetchWindow":{"type":"object","properties":{"start":{"type":["string","null"]},"end":{"type":["string","null"]}},"required":["start","end"],"additionalProperties":false},"largeWindow":{"type":"boolean"},"primaryWindow":{"type":"object","properties":{"startDate":{"type":"string"},"endDate":{"type":"string"},"rowsConsidered":{"type":"integer"}},"required":["startDate","endDate","rowsConsidered"],"additionalProperties":false},"comparisonWindow":{"type":"object","properties":{"startDate":{"type":"string"},"endDate":{"type":"string"},"rowsConsidered":{"type":"integer"}},"required":["startDate","endDate","rowsConsidered"],"additionalProperties":false},"notes":{"type":"array","items":{"type":"string"}}},"required":["dateBasis","timezone","currencyMode","generatedAt","notes"],"additionalProperties":false},"rows":{"type":"array","items":{"type":"object","properties":{"groupId":{"type":["string","null"],"format":"uuid"},"bucketKey":{"type":"string"},"groupName":{"type":"string"},"group2Id":{"type":["string","null"],"format":"uuid"},"group2Key":{"type":"string"},"group2Name":{"type":"string"},"spendCents":{"type":"string"},"orderCount":{"type":"integer"},"itemCount":{"type":"integer"},"firstDate":{"type":["string","null"]},"lastDate":{"type":["string","null"]},"comparison":{"type":"object","properties":{"spendCents":{"type":"string"},"orderCount":{"type":"integer"},"itemCount":{"type":"integer"},"firstDate":{"type":["string","null"]},"lastDate":{"type":["string","null"]}},"required":["spendCents","orderCount","itemCount","firstDate","lastDate"],"additionalProperties":false},"deltas":{"type":"object","properties":{"spendCents":{"type":"string"},"orderCount":{"type":"integer"},"itemCount":{"type":"integer"}},"required":["spendCents","orderCount","itemCount"],"additionalProperties":false},"comparisonClassification":{"type":"string","enum":["new","lost","retained"]}},"required":["groupId","bucketKey","groupName","spendCents","orderCount","itemCount","firstDate","lastDate"],"additionalProperties":false}},"totals":{"type":"object","properties":{"scope":{"type":"string","enum":["filtered-population-before-pagination"]},"primary":{"type":"object","properties":{"spendCents":{"type":"string"},"itemCount":{"type":"integer"}},"required":["spendCents","itemCount"],"additionalProperties":false},"comparison":{"type":"object","properties":{"spendCents":{"type":"string"},"itemCount":{"type":"integer"}},"required":["spendCents","itemCount"],"additionalProperties":false},"deltas":{"type":"object","properties":{"spendCents":{"type":"string"},"itemCount":{"type":"integer"}},"required":["spendCents","itemCount"],"additionalProperties":false}},"required":["scope","primary"],"additionalProperties":false},"meta":{"type":"object","properties":{"totalGroups":{"type":"integer"},"returnedGroups":{"type":"integer"},"truncated":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"ordering":{"type":"string"},"hasMoreAfterPage":{"type":"boolean"},"rowsCoverFullPopulation":{"type":"boolean"},"rankingComplete":{"type":"boolean"},"sortBy":{"type":"string"},"sortDirection":{"type":"string","enum":["asc","desc"]}},"required":["totalGroups","returnedGroups","truncated","limit","offset","ordering","rowsCoverFullPopulation","rankingComplete"],"additionalProperties":false}},"required":["report","params","basis","rows","totals","meta"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"report":{"type":"object","properties":{"key":{"type":"string","enum":["open-sales-orders"]},"title":{"type":"string"},"description":{"type":"string"},"params":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"required":{"type":"boolean"},"description":{"type":"string"},"values":{"type":"array","items":{"type":"string"}},"defaultValue":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}}]}},"required":["name","required","description"],"additionalProperties":false}},"dimensions":{"type":"array","items":{"type":"string"}},"measures":{"type":"array","items":{"type":"string"}},"requiredScope":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]},"requiredScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"allowedForThisKey":{"type":"boolean"}},"required":["key","title","description","params","dimensions","measures","requiredScope","allowedForThisKey"],"additionalProperties":false},"params":{"type":"object","additionalProperties":{}},"basis":{"type":"object","properties":{"dateBasis":{"type":"string"},"timezone":{"type":"string"},"currencyMode":{"type":"string","enum":["org-base"]},"generatedAt":{"type":"string","format":"date-time"},"startDate":{"type":"string"},"endDate":{"type":"string"},"statusesRequested":{"type":"array","items":{"type":"string"}},"statusesEffective":{"type":"array","items":{"type":"string"}},"lineType":{"type":"string"},"rowsConsidered":{"type":"integer"},"fetchWindow":{"type":"object","properties":{"start":{"type":["string","null"]},"end":{"type":["string","null"]}},"required":["start","end"],"additionalProperties":false},"largeWindow":{"type":"boolean"},"primaryWindow":{"type":"object","properties":{"startDate":{"type":"string"},"endDate":{"type":"string"},"rowsConsidered":{"type":"integer"}},"required":["startDate","endDate","rowsConsidered"],"additionalProperties":false},"comparisonWindow":{"type":"object","properties":{"startDate":{"type":"string"},"endDate":{"type":"string"},"rowsConsidered":{"type":"integer"}},"required":["startDate","endDate","rowsConsidered"],"additionalProperties":false},"notes":{"type":"array","items":{"type":"string"}}},"required":["dateBasis","timezone","currencyMode","generatedAt","notes"],"additionalProperties":false},"rows":{"type":"array","items":{"type":"object","properties":{"groupId":{"type":["string","null"],"format":"uuid"},"bucketKey":{"type":"string"},"groupName":{"type":"string"},"group2Id":{"type":["string","null"],"format":"uuid"},"group2Key":{"type":"string"},"group2Name":{"type":"string"},"orderCount":{"type":"integer"},"itemCount":{"type":"integer"},"openValueCents":{"type":"string"}},"required":["groupId","bucketKey","groupName","orderCount","itemCount","openValueCents"],"additionalProperties":false}},"meta":{"type":"object","properties":{"totalGroups":{"type":"integer"},"returnedGroups":{"type":"integer"},"truncated":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"ordering":{"type":"string"},"hasMoreAfterPage":{"type":"boolean"},"rowsCoverFullPopulation":{"type":"boolean"},"rankingComplete":{"type":"boolean"},"sortBy":{"type":"string"},"sortDirection":{"type":"string","enum":["asc","desc"]}},"required":["totalGroups","returnedGroups","truncated","limit","offset","ordering"],"additionalProperties":false}},"required":["report","params","basis","rows","meta"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"report":{"type":"object","properties":{"key":{"type":"string","enum":["ar-aging"]},"title":{"type":"string"},"description":{"type":"string"},"params":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"required":{"type":"boolean"},"description":{"type":"string"},"values":{"type":"array","items":{"type":"string"}},"defaultValue":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}}]}},"required":["name","required","description"],"additionalProperties":false}},"dimensions":{"type":"array","items":{"type":"string"}},"measures":{"type":"array","items":{"type":"string"}},"requiredScope":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]},"requiredScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"allowedForThisKey":{"type":"boolean"}},"required":["key","title","description","params","dimensions","measures","requiredScope","allowedForThisKey"],"additionalProperties":false},"params":{"type":"object","additionalProperties":{}},"basis":{"type":"object","properties":{"dateBasis":{"type":"string","enum":["current-org-calendar-day"]},"timezone":{"type":"string"},"asOfDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"generatedAt":{"type":"string","format":"date-time"},"baseCurrencyCode":{"type":"string"},"accountingCutoverDay":{"type":["string","null"]},"coverageStartDate":{"type":["string","null"]},"historyState":{"type":"string","enum":["certified","preview","unverified_configuration_gap"]},"creditsIncluded":{"type":"boolean"},"currencyLaneNote":{"type":"string","enum":["transaction_currency_lanes"]},"paymentBehaviorBasis":{"type":["object","null"],"properties":{"observation":{"type":"string"},"learningWindow":{"type":"string"},"usualDaysLate":{"type":"string"},"recentDaysLate":{"type":"string"},"averageDaysToPay":{"type":"string"},"lastPaymentDate":{"type":"string"},"olderDueOpenCents":{"type":"string"},"olderDuePaidInWindowCents":{"type":"string"}},"required":["observation","learningWindow","usualDaysLate","recentDaysLate","averageDaysToPay","lastPaymentDate","olderDueOpenCents","olderDuePaidInWindowCents"],"additionalProperties":false},"notes":{"type":"array","items":{"type":"string"}},"currencyMode":{"type":"string","enum":["transaction-currency-subledger-ar"]}},"required":["dateBasis","timezone","asOfDate","generatedAt","baseCurrencyCode","accountingCutoverDay","coverageStartDate","historyState","creditsIncluded","currencyLaneNote","paymentBehaviorBasis","notes","currencyMode"],"additionalProperties":false},"rows":{"type":"array","items":{"type":"object","properties":{"transactionCurrencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"openDocumentCents":{"type":"string","pattern":"^-?\\d+$"},"openCreditCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"netCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"pastDueDocumentCents":{"type":"string","pattern":"^-?\\d+$"},"currentCents":{"type":"string","pattern":"^-?\\d+$"},"days1To30Cents":{"type":"string","pattern":"^-?\\d+$"},"days31To60Cents":{"type":"string","pattern":"^-?\\d+$"},"days61To90Cents":{"type":"string","pattern":"^-?\\d+$"},"days90PlusCents":{"type":"string","pattern":"^-?\\d+$"},"over365Cents":{"type":"string","pattern":"^-?\\d+$"},"unknownCents":{"type":"string","pattern":"^-?\\d+$"},"dueByCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"openingAmountCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"openingDocumentCount":{"type":"integer","minimum":0},"openDocumentCount":{"type":"integer","minimum":0},"pastDueDocumentCount":{"type":"integer","minimum":0},"unknownDueDocumentCount":{"type":"integer","minimum":0},"openCreditCount":{"type":["integer","null"],"minimum":0},"counterpartyId":{"type":"string","format":"uuid"},"counterpartyName":{"type":"string"},"counterpartyStatus":{"type":"string","enum":["active","prospect","archived"]},"oldestDueDate":{"type":["string","null"],"pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"oldestDaysPastDue":{"type":["integer","null"],"minimum":0},"paymentBehavior":{"type":["object","null"],"properties":{"lastPaymentDate":{"type":["string","null"]},"usualDaysLate":{"type":["number","null"],"description":"Median final cash day minus due day across eligible documents in the learning window."},"recentDaysLate":{"type":["number","null"],"description":"Median final cash day minus due day across eligible documents settled in the last 90 days within that window."},"averageDaysToPay":{"type":["number","null"],"description":"Arithmetic mean final cash day minus document day across eligible documents in the learning window."},"nativePaidDocumentCount":{"type":"integer"},"settledOtherwiseCount":{"type":"integer"},"olderDueOpenCents":{"type":"string"},"olderDuePaidInWindowCents":{"type":["string","null"]},"olderDueCreditInWindowCents":{"type":["string","null"]},"olderDueAdjustmentInWindowCents":{"type":["string","null"]},"cashUnavailableCount":{"type":"integer"},"crossCurrencyCashCount":{"type":"integer"},"coverageStartDate":{"type":["string","null"]},"cashUnavailableReason":{"type":["string","null"],"enum":["legacy_mixed_cash_and_credit","mixed_cash_and_credit_attribution_unrecorded","cross_currency_cash"]}},"required":["lastPaymentDate","usualDaysLate","recentDaysLate","averageDaysToPay","nativePaidDocumentCount","settledOtherwiseCount","olderDueOpenCents","olderDuePaidInWindowCents","olderDueCreditInWindowCents","olderDueAdjustmentInWindowCents","cashUnavailableCount","crossCurrencyCashCount","coverageStartDate","cashUnavailableReason"],"additionalProperties":false},"openInvoiceCents":{"type":"string","pattern":"^-?\\d+$"},"unappliedCreditCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"pastDueInvoiceCents":{"type":"string","pattern":"^-?\\d+$"},"openInvoiceCount":{"type":"integer","minimum":0},"pastDueInvoiceCount":{"type":"integer","minimum":0},"unknownDueInvoiceCount":{"type":"integer","minimum":0},"customerId":{"type":"string","format":"uuid"},"customerName":{"type":"string"}},"required":["transactionCurrencyCode","openDocumentCents","openCreditCents","netCents","pastDueDocumentCents","currentCents","days1To30Cents","days31To60Cents","days61To90Cents","days90PlusCents","over365Cents","unknownCents","dueByCents","openingAmountCents","openingDocumentCount","openDocumentCount","pastDueDocumentCount","unknownDueDocumentCount","openCreditCount","counterpartyId","counterpartyName","counterpartyStatus","oldestDueDate","oldestDaysPastDue","paymentBehavior","openInvoiceCents","unappliedCreditCents","pastDueInvoiceCents","openInvoiceCount","pastDueInvoiceCount","unknownDueInvoiceCount","customerId","customerName"],"additionalProperties":false}},"totals":{"type":"object","properties":{"scope":{"type":"string","enum":["filtered-population-before-pagination"]},"byTransactionCurrency":{"type":"array","items":{"type":"object","properties":{"transactionCurrencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"openDocumentCents":{"type":"string","pattern":"^-?\\d+$"},"openCreditCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"netCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"pastDueDocumentCents":{"type":"string","pattern":"^-?\\d+$"},"currentCents":{"type":"string","pattern":"^-?\\d+$"},"days1To30Cents":{"type":"string","pattern":"^-?\\d+$"},"days31To60Cents":{"type":"string","pattern":"^-?\\d+$"},"days61To90Cents":{"type":"string","pattern":"^-?\\d+$"},"days90PlusCents":{"type":"string","pattern":"^-?\\d+$"},"over365Cents":{"type":"string","pattern":"^-?\\d+$"},"unknownCents":{"type":"string","pattern":"^-?\\d+$"},"dueByCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"openingAmountCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"openingDocumentCount":{"type":"integer","minimum":0},"openDocumentCount":{"type":"integer","minimum":0},"pastDueDocumentCount":{"type":"integer","minimum":0},"unknownDueDocumentCount":{"type":"integer","minimum":0},"openCreditCount":{"type":["integer","null"],"minimum":0},"openInvoiceCents":{"type":"string","pattern":"^-?\\d+$"},"unappliedCreditCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"pastDueInvoiceCents":{"type":"string","pattern":"^-?\\d+$"},"openInvoiceCount":{"type":"integer","minimum":0},"pastDueInvoiceCount":{"type":"integer","minimum":0},"unknownDueInvoiceCount":{"type":"integer","minimum":0}},"required":["transactionCurrencyCode","openDocumentCents","openCreditCents","netCents","pastDueDocumentCents","currentCents","days1To30Cents","days31To60Cents","days61To90Cents","days90PlusCents","over365Cents","unknownCents","dueByCents","openingAmountCents","openingDocumentCount","openDocumentCount","pastDueDocumentCount","unknownDueDocumentCount","openCreditCount","openInvoiceCents","unappliedCreditCents","pastDueInvoiceCents","openInvoiceCount","pastDueInvoiceCount","unknownDueInvoiceCount"],"additionalProperties":false}},"baseCurrencyCode":{"type":"string"},"baseOpenDocumentCents":{"type":"string","pattern":"^-?\\d+$"},"baseOpenCreditCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"baseNetCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"openingBaseAmountCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"openingDocumentCount":{"type":"integer","minimum":0}},"required":["scope","byTransactionCurrency","baseCurrencyCode","baseOpenDocumentCents","baseOpenCreditCents","baseNetCents","openingBaseAmountCents","openingDocumentCount"],"additionalProperties":false},"drafts":{"type":"object","properties":{"count":{"type":"integer","minimum":0},"byTransactionCurrency":{"type":"array","items":{"type":"object","properties":{"transactionCurrencyCode":{"type":"string"},"count":{"type":"integer","minimum":0},"amountCents":{"type":"string","pattern":"^-?\\d+$"}},"required":["transactionCurrencyCode","count","amountCents"],"additionalProperties":false}}},"required":["count","byTransactionCurrency"],"additionalProperties":false},"paymentsBeingPrepared":{"type":["object","null"],"properties":{"scope":{"type":"string","enum":["organization","supplier"]},"batchCount":{"type":"integer","minimum":0},"oldestCreatedDate":{"type":["string","null"]},"byTransactionCurrency":{"type":"array","items":{"type":"object","properties":{"transactionCurrencyCode":{"type":"string"},"count":{"type":"integer","minimum":0},"amountCents":{"type":"string","pattern":"^-?\\d+$"}},"required":["transactionCurrencyCode","count","amountCents"],"additionalProperties":false}}},"required":["scope","batchCount","oldestCreatedDate","byTransactionCurrency"],"additionalProperties":false},"hygieneFacts":{"type":"array","items":{"type":"object","properties":{"counterpartyStatus":{"type":"string","enum":["archived","prospect"]},"transactionCurrencyCode":{"type":"string"},"counterpartyCount":{"type":"integer","minimum":0},"openDocumentCents":{"type":"string","pattern":"^-?\\d+$"}},"required":["counterpartyStatus","transactionCurrencyCode","counterpartyCount","openDocumentCents"],"additionalProperties":false}},"meta":{"type":"object","properties":{"totalGroups":{"type":"integer"},"returnedGroups":{"type":"integer"},"truncated":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"ordering":{"type":"string"},"hasMoreAfterPage":{"type":"boolean"},"rowsCoverFullPopulation":{"type":"boolean"},"rankingComplete":{"type":"boolean","enum":[true]},"sortBy":{"type":"string","enum":["netCents","pastDueInvoiceCents","days90PlusCents","oldestDaysPastDue"]},"sortDirection":{"type":"string","enum":["asc","desc"]},"populationDiagnostics":{"type":"object","properties":{"negativeDueCount":{"type":"integer","minimum":0},"paidWithDueCount":{"type":"integer","minimum":0},"postedZeroDueCount":{"type":"integer","minimum":0},"creditIncoherentCount":{"type":["integer","null"],"minimum":0},"zeroPaidPartialCount":{"type":"integer","minimum":0},"incoherentRecordCount":{"type":"integer","minimum":0}},"required":["negativeDueCount","paidWithDueCount","postedZeroDueCount","creditIncoherentCount","zeroPaidPartialCount","incoherentRecordCount"],"additionalProperties":false}},"required":["totalGroups","returnedGroups","truncated","limit","offset","ordering","rankingComplete","sortBy","sortDirection","populationDiagnostics"],"additionalProperties":false}},"required":["report","params","basis","rows","totals","drafts","paymentsBeingPrepared","hygieneFacts","meta"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"report":{"type":"object","properties":{"key":{"type":"string","enum":["pipeline-summary"]},"title":{"type":"string"},"description":{"type":"string"},"params":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"required":{"type":"boolean"},"description":{"type":"string"},"values":{"type":"array","items":{"type":"string"}},"defaultValue":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}}]}},"required":["name","required","description"],"additionalProperties":false}},"dimensions":{"type":"array","items":{"type":"string"}},"measures":{"type":"array","items":{"type":"string"}},"requiredScope":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]},"requiredScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"allowedForThisKey":{"type":"boolean"}},"required":["key","title","description","params","dimensions","measures","requiredScope","allowedForThisKey"],"additionalProperties":false},"params":{"type":"object","additionalProperties":{}},"basis":{"type":"object","properties":{"dateBasis":{"type":"string","enum":["opportunity-created-at"]},"timezone":{"type":"string"},"currencyMode":{"type":"string","enum":["single-org-base-estimate"]},"currencyCode":{"type":["string","null"],"pattern":"^[A-Z]{3}$"},"generatedAt":{"type":"string","format":"date-time"},"notes":{"type":"array","items":{"type":"string"}}},"required":["dateBasis","timezone","currencyMode","currencyCode","generatedAt","notes"],"additionalProperties":false},"rows":{"type":"array","items":{"type":"object","properties":{"groupId":{"type":["string","null"],"format":"uuid"},"bucketKey":{"type":"string"},"groupName":{"type":"string"},"opportunityCount":{"type":"integer","minimum":0},"estimatedValueTotal":{"type":"string","pattern":"^\\d+(?:\\.\\d{2})$"},"currencyCode":{"type":["string","null"],"pattern":"^[A-Z]{3}$"},"noValueCount":{"type":"integer","minimum":0},"wonCount":{"type":"integer","minimum":0},"lostCount":{"type":"integer","minimum":0},"oldestOpenCreatedAt":{"type":["string","null"],"format":"date-time"}},"required":["groupId","bucketKey","groupName","opportunityCount","estimatedValueTotal","currencyCode","noValueCount","wonCount","lostCount","oldestOpenCreatedAt"],"additionalProperties":false}},"totals":{"type":"object","properties":{"scope":{"type":"string","enum":["filtered-opportunity-population-before-pagination"]},"opportunityCount":{"type":"integer","minimum":0},"estimatedValueTotal":{"type":"string","pattern":"^\\d+(?:\\.\\d{2})$"},"currencyCode":{"type":["string","null"],"pattern":"^[A-Z]{3}$"},"noValueCount":{"type":"integer","minimum":0},"wonCount":{"type":"integer","minimum":0},"lostCount":{"type":"integer","minimum":0}},"required":["scope","opportunityCount","estimatedValueTotal","currencyCode","noValueCount","wonCount","lostCount"],"additionalProperties":false},"meta":{"type":"object","properties":{"totalGroups":{"type":"integer"},"returnedGroups":{"type":"integer"},"truncated":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"ordering":{"type":"string"},"hasMoreAfterPage":{"type":"boolean"},"rowsCoverFullPopulation":{"type":"boolean"},"rankingComplete":{"type":"boolean"},"sortBy":{"type":"string"},"sortDirection":{"type":"string","enum":["asc","desc"]}},"required":["totalGroups","returnedGroups","truncated","limit","offset","ordering"],"additionalProperties":false}},"required":["report","params","basis","rows","totals","meta"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"params":{"type":"object","properties":{"customerId":{"type":["string","null"],"format":"uuid","default":null},"from":{"type":["string","null"],"pattern":"^\\d{4}-\\d{2}-\\d{2}$","default":null},"to":{"type":["string","null"],"pattern":"^\\d{4}-\\d{2}-\\d{2}$","default":null},"includeOpeningDocuments":{"type":"boolean","default":false},"limit":{"type":"integer","minimum":1,"maximum":100,"default":25}},"additionalProperties":false},"basis":{"type":"object","properties":{"organization":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","minLength":1,"maxLength":500},"timezone":{"type":"string","minLength":1,"maxLength":500},"baseCurrencyCode":{"type":"string","pattern":"^[A-Z]{3}$"}},"required":["id","name","timezone","baseCurrencyCode"],"additionalProperties":false},"customerScope":{"type":"object","properties":{"kind":{"type":"string","enum":["all","customer"]},"customerId":{"type":["string","null"],"format":"uuid"},"customerName":{"type":["string","null"],"minLength":1,"maxLength":500}},"required":["kind","customerId","customerName"],"additionalProperties":false},"requestedWindow":{"type":"object","properties":{"from":{"type":["string","null"],"pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"to":{"type":["string","null"],"pattern":"^\\d{4}-\\d{2}-\\d{2}$"}},"required":["from","to"],"additionalProperties":false},"effectiveWindow":{"type":"object","properties":{"from":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"to":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"}},"required":["from","to"],"additionalProperties":false},"currencyBasis":{"type":"object","properties":{"kind":{"type":"string","enum":["organization_base_currency"]},"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"}},"required":["kind","currencyCode"],"additionalProperties":false},"population":{"type":"string","minLength":1,"maxLength":500},"exclusions":{"type":"array","items":{"type":"string","minLength":1,"maxLength":500}},"historyState":{"type":"string","enum":["certified","preview","unverified_configuration_gap"]},"accountingCutoverDay":{"type":["string","null"],"pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"paymentBehaviorBasis":{"type":["object","null"],"properties":{"observation":{"type":"string"},"learningWindow":{"type":"string"},"usualDaysLate":{"type":"string"},"recentDaysLate":{"type":"string"},"averageDaysToPay":{"type":"string"},"lastPaymentDate":{"type":"string"},"olderDueOpenCents":{"type":"string"},"olderDuePaidInWindowCents":{"type":"string"}},"required":["observation","learningWindow","usualDaysLate","recentDaysLate","averageDaysToPay","lastPaymentDate","olderDueOpenCents","olderDuePaidInWindowCents"],"additionalProperties":false}},"required":["organization","customerScope","requestedWindow","effectiveWindow","currencyBasis","population","exclusions","historyState","accountingCutoverDay","paymentBehaviorBasis"],"additionalProperties":false},"rows":{"type":"array","items":{"type":"object","properties":{"invoiceId":{"type":"string","format":"uuid"},"invoiceNumber":{"type":"string","minLength":1,"maxLength":500},"customerId":{"type":"string","format":"uuid"},"customerName":{"type":"string","minLength":1,"maxLength":500},"counterpartyStatus":{"type":"string","enum":["active","prospect","archived"]},"cohort":{"type":"string","enum":["native","opening_ar","preview"]},"invoiceDay":{"type":["string","null"],"pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"dueDay":{"type":["string","null"],"pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"finalSettlementDay":{"type":["string","null"],"pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"dateProvenance":{"type":"string","enum":["materialized_paid_date","derived_from_posted_allocations","materialized_and_derived_agree","materialized_and_derived_diverge","unavailable"]},"daysToFinalSettlement":{"type":["integer","null"]},"daysVersusDue":{"type":["integer","null"]},"transactionCurrencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"transactionAmountCents":{"type":"string","pattern":"^-?\\d+$"},"baseAmountCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"writeOffBaseAmountCents":{"type":["string","null"],"pattern":"^-?\\d+$"}},"required":["invoiceId","invoiceNumber","customerId","customerName","counterpartyStatus","cohort","invoiceDay","dueDay","finalSettlementDay","dateProvenance","daysToFinalSettlement","daysVersusDue","transactionCurrencyCode","transactionAmountCents","baseAmountCents","writeOffBaseAmountCents"],"additionalProperties":false}},"customerRows":{"type":"array","items":{"type":"object","properties":{"lastPaymentDate":{"type":["string","null"]},"usualDaysLate":{"type":["number","null"],"description":"Median final cash day minus due day across eligible documents in the learning window."},"recentDaysLate":{"type":["number","null"],"description":"Median final cash day minus due day across eligible documents settled in the last 90 days within that window."},"averageDaysToPay":{"type":["number","null"],"description":"Arithmetic mean final cash day minus document day across eligible documents in the learning window."},"nativePaidDocumentCount":{"type":"integer"},"settledOtherwiseCount":{"type":"integer"},"olderDueOpenCents":{"type":"string"},"olderDuePaidInWindowCents":{"type":["string","null"]},"olderDueCreditInWindowCents":{"type":["string","null"]},"olderDueAdjustmentInWindowCents":{"type":["string","null"]},"cashUnavailableCount":{"type":"integer"},"crossCurrencyCashCount":{"type":"integer"},"coverageStartDate":{"type":["string","null"]},"cashUnavailableReason":{"type":["string","null"],"enum":["legacy_mixed_cash_and_credit","mixed_cash_and_credit_attribution_unrecorded","cross_currency_cash"]},"customerId":{"type":"string","format":"uuid"},"customerName":{"type":"string","minLength":1,"maxLength":500},"counterpartyStatus":{"type":"string","enum":["active","prospect","archived"]},"transactionCurrencyCode":{"type":"string","pattern":"^[A-Z]{3}$"}},"required":["lastPaymentDate","usualDaysLate","recentDaysLate","averageDaysToPay","nativePaidDocumentCount","settledOtherwiseCount","olderDueOpenCents","olderDuePaidInWindowCents","olderDueCreditInWindowCents","olderDueAdjustmentInWindowCents","cashUnavailableCount","crossCurrencyCashCount","coverageStartDate","cashUnavailableReason","customerId","customerName","counterpartyStatus","transactionCurrencyCode"],"additionalProperties":false}},"totals":{"type":"object","properties":{"settledInvoiceCount":{"type":"integer","minimum":0},"settledBaseAmountCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"weightedAverageDaysToFinalSettlement":{"type":["number","null"]},"weightedAverageDaysVersusDue":{"type":["number","null"]},"medianDaysVersusDue":{"type":["number","null"]},"onTimeByCount":{"type":"object","properties":{"numerator":{"type":"integer","minimum":0},"denominator":{"type":"integer","minimum":0}},"required":["numerator","denominator"],"additionalProperties":false},"onTimeByBaseAmount":{"type":"object","properties":{"numeratorCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"denominatorCents":{"type":["string","null"],"pattern":"^-?\\d+$"}},"required":["numeratorCents","denominatorCents"],"additionalProperties":false}},"required":["settledInvoiceCount","settledBaseAmountCents","weightedAverageDaysToFinalSettlement","weightedAverageDaysVersusDue","medianDaysVersusDue","onTimeByCount","onTimeByBaseAmount"],"additionalProperties":false},"meta":{"type":"object","properties":{"sourcePopulationCount":{"type":"integer","minimum":0},"resultPopulationCount":{"type":"integer","minimum":0},"totalGroups":{"type":"integer","minimum":0},"returnedGroups":{"type":"integer","minimum":0},"truncated":{"type":"boolean"},"limit":{"type":"integer","exclusiveMinimum":0},"offset":{"type":"number","enum":[0]},"ordering":{"type":"string","minLength":1,"maxLength":500},"observedAt":{"type":"string","format":"date-time"},"evidenceComplete":{"type":"boolean"},"coverage":{"type":"object","properties":{"materializedDates":{"type":"integer","minimum":0},"derivedDates":{"type":"integer","minimum":0},"agreeingDates":{"type":"integer","minimum":0},"divergentDates":{"type":"integer","minimum":0},"missingSettlementDates":{"type":"integer","minimum":0},"missingInvoiceDates":{"type":"integer","minimum":0},"missingDueDates":{"type":"integer","minimum":0},"missingBaseAmounts":{"type":"integer","minimum":0},"missingWriteOffBaseAmounts":{"type":"integer","minimum":0}},"required":["materializedDates","derivedDates","agreeingDates","divergentDates","missingSettlementDates","missingInvoiceDates","missingDueDates","missingBaseAmounts","missingWriteOffBaseAmounts"],"additionalProperties":false}},"required":["sourcePopulationCount","resultPopulationCount","totalGroups","returnedGroups","truncated","limit","offset","ordering","observedAt","evidenceComplete","coverage"],"additionalProperties":false},"report":{"type":"object","properties":{"key":{"type":"string","enum":["customer-invoice-settlement-behavior"]},"title":{"type":"string"},"description":{"type":"string"},"params":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"required":{"type":"boolean"},"description":{"type":"string"},"values":{"type":"array","items":{"type":"string"}},"defaultValue":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}}]}},"required":["name","required","description"],"additionalProperties":false}},"dimensions":{"type":"array","items":{"type":"string"}},"measures":{"type":"array","items":{"type":"string"}},"requiredScope":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]},"requiredScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"allowedForThisKey":{"type":"boolean"}},"required":["key","title","description","params","dimensions","measures","requiredScope","allowedForThisKey"],"additionalProperties":false}},"required":["params","basis","rows","customerRows","totals","meta","report"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"params":{"type":"object","properties":{"customerId":{"type":["string","null"],"format":"uuid","default":null},"sortBy":{"type":"string","enum":["totalExposure","overage","utilization","postedExposure","committedExposure","customerName"],"default":"totalExposure"},"sortDirection":{"type":"string","enum":["asc","desc"],"default":"desc"},"flags":{"type":"array","items":{"type":"string","enum":["within_posted_over_with_commitments","over_limit","shipped_or_delivered_unbilled","no_limit","credit_limit_configuration_issue","incomplete_financial_evidence"]},"maxItems":6,"default":[]},"limit":{"type":"integer","minimum":1,"maximum":500,"default":100}},"additionalProperties":false},"basis":{"type":"object","properties":{"organization":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","minLength":1,"maxLength":500},"timezone":{"type":"string","minLength":1,"maxLength":500},"baseCurrencyCode":{"type":"string","pattern":"^[A-Z]{3}$"}},"required":["id","name","timezone","baseCurrencyCode"],"additionalProperties":false},"customerScope":{"type":"object","properties":{"kind":{"type":"string","enum":["all","customer"]},"customerId":{"type":["string","null"],"format":"uuid"},"customerName":{"type":["string","null"],"minLength":1,"maxLength":500}},"required":["kind","customerId","customerName"],"additionalProperties":false},"asOf":{"type":"string","format":"date-time"},"currencyBasis":{"type":"object","properties":{"kind":{"type":"string","enum":["organization_base_currency"]},"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"}},"required":["kind","currencyCode"],"additionalProperties":false},"population":{"type":"string","minLength":1,"maxLength":500},"exclusions":{"type":"array","items":{"type":"string","minLength":1,"maxLength":500}}},"required":["organization","customerScope","asOf","currencyBasis","population","exclusions"],"additionalProperties":false},"rows":{"type":"array","items":{"type":"object","properties":{"customerId":{"type":"string","format":"uuid"},"customerName":{"type":"string","minLength":1,"maxLength":500},"counterpartyStatus":{"type":"string","enum":["active","prospect","archived"]},"grossOpenInvoiceBaseCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"openCreditBaseCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"netPostedExposureBaseCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"committedUninvoicedBaseCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"committedByOrderState":{"type":"object","properties":{"confirmedBaseCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"shippedBaseCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"deliveredBaseCents":{"type":["string","null"],"pattern":"^-?\\d+$"}},"required":["confirmedBaseCents","shippedBaseCents","deliveredBaseCents"],"additionalProperties":false},"totalExposureBaseCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"creditLimit":{"type":"object","properties":{"state":{"type":"string","enum":["available","missing","ambiguous","conflicting_legacy_values"]},"baseCents":{"type":["string","null"],"pattern":"^-?\\d+$"}},"required":["state","baseCents"],"additionalProperties":false},"availableCreditBaseCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"utilizationPercent":{"type":["number","null"]},"overageBaseCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"flags":{"type":"array","items":{"type":"string","enum":["within_posted_over_with_commitments","over_limit","shipped_or_delivered_unbilled","no_limit","credit_limit_configuration_issue","incomplete_financial_evidence"]}},"coverage":{"type":"object","properties":{"missingInvoiceBaseRows":{"type":"integer","minimum":0},"missingCreditBaseRows":{"type":"integer","minimum":0},"missingOrderBaseRows":{"type":"integer","minimum":0},"unmatchedInvoiceAttributionRows":{"type":"integer","minimum":0}},"required":["missingInvoiceBaseRows","missingCreditBaseRows","missingOrderBaseRows","unmatchedInvoiceAttributionRows"],"additionalProperties":false}},"required":["customerId","customerName","counterpartyStatus","grossOpenInvoiceBaseCents","openCreditBaseCents","netPostedExposureBaseCents","committedUninvoicedBaseCents","committedByOrderState","totalExposureBaseCents","creditLimit","availableCreditBaseCents","utilizationPercent","overageBaseCents","flags","coverage"],"additionalProperties":false}},"totals":{"type":"object","properties":{"grossOpenInvoiceBaseCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"openCreditBaseCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"netPostedExposureBaseCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"committedUninvoicedBaseCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"totalExposureBaseCents":{"type":["string","null"],"pattern":"^-?\\d+$"}},"required":["grossOpenInvoiceBaseCents","openCreditBaseCents","netPostedExposureBaseCents","committedUninvoicedBaseCents","totalExposureBaseCents"],"additionalProperties":false},"flagSummaries":{"type":"array","items":{"type":"object","properties":{"flag":{"type":"string","enum":["within_posted_over_with_commitments","over_limit","shipped_or_delivered_unbilled","no_limit","credit_limit_configuration_issue","incomplete_financial_evidence"]},"customerCount":{"type":"integer","minimum":0},"totalExposureBaseCents":{"type":["string","null"],"pattern":"^-?\\d+$"}},"required":["flag","customerCount","totalExposureBaseCents"],"additionalProperties":false}},"meta":{"type":"object","properties":{"sourcePopulationCount":{"type":"integer","minimum":0},"resultPopulationCount":{"type":"integer","minimum":0},"totalGroups":{"type":"integer","minimum":0},"returnedGroups":{"type":"integer","minimum":0},"truncated":{"type":"boolean"},"limit":{"type":"integer","exclusiveMinimum":0},"offset":{"type":"number","enum":[0]},"ordering":{"type":"string","minLength":1,"maxLength":500},"observedAt":{"type":"string","format":"date-time"},"evidenceComplete":{"type":"boolean"}},"required":["sourcePopulationCount","resultPopulationCount","totalGroups","returnedGroups","truncated","limit","offset","ordering","observedAt","evidenceComplete"],"additionalProperties":false},"report":{"type":"object","properties":{"key":{"type":"string","enum":["customer-credit-exposure"]},"title":{"type":"string"},"description":{"type":"string"},"params":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"required":{"type":"boolean"},"description":{"type":"string"},"values":{"type":"array","items":{"type":"string"}},"defaultValue":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}}]}},"required":["name","required","description"],"additionalProperties":false}},"dimensions":{"type":"array","items":{"type":"string"}},"measures":{"type":"array","items":{"type":"string"}},"requiredScope":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]},"requiredScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"allowedForThisKey":{"type":"boolean"}},"required":["key","title","description","params","dimensions","measures","requiredScope","allowedForThisKey"],"additionalProperties":false}},"required":["params","basis","rows","totals","flagSummaries","meta","report"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"params":{"type":"object","properties":{"customerId":{"type":["string","null"],"format":"uuid","default":null},"from":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"to":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"costCategoryId":{"type":["string","null"],"format":"uuid","default":null},"query":{"type":["string","null"],"minLength":1,"maxLength":120,"default":null},"limit":{"type":"integer","minimum":1,"maximum":100,"default":25}},"required":["from","to"],"additionalProperties":false},"basis":{"type":"object","properties":{"organization":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","minLength":1,"maxLength":500},"timezone":{"type":"string","minLength":1,"maxLength":500},"baseCurrencyCode":{"type":"string","pattern":"^[A-Z]{3}$"}},"required":["id","name","timezone","baseCurrencyCode"],"additionalProperties":false},"customerScope":{"type":"object","properties":{"kind":{"type":"string","enum":["all","customer"]},"customerId":{"type":["string","null"],"format":"uuid"},"customerName":{"type":["string","null"],"minLength":1,"maxLength":500}},"required":["kind","customerId","customerName"],"additionalProperties":false},"window":{"type":"object","properties":{"from":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"to":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"}},"required":["from","to"],"additionalProperties":false},"dateBasis":{"type":"string","enum":["invoice_or_credit_posted_day"]},"currencyBasis":{"type":"object","properties":{"kind":{"type":"string","enum":["organization_base_currency"]},"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"}},"required":["kind","currencyCode"],"additionalProperties":false},"population":{"type":"string","minLength":1,"maxLength":500},"exclusions":{"type":"array","items":{"type":"string","minLength":1,"maxLength":500}}},"required":["organization","customerScope","window","dateBasis","currencyBasis","population","exclusions"],"additionalProperties":false},"rows":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["invoice_charge","matched_credit"]},"recordId":{"type":"string","format":"uuid"},"customerId":{"type":"string","format":"uuid"},"customerName":{"type":"string","minLength":1,"maxLength":500},"counterpartyStatus":{"type":"string","enum":["active","prospect","archived"]},"postedDay":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"documentNumber":{"type":"string","minLength":1,"maxLength":500},"description":{"type":"string","minLength":1,"maxLength":500},"ledgerAccountId":{"type":["string","null"],"format":"uuid"},"ledgerAccountName":{"type":["string","null"],"minLength":1,"maxLength":500},"ledgerAccountPath":{"type":["string","null"],"minLength":1,"maxLength":500},"costCategoryId":{"type":["string","null"],"format":"uuid"},"matchReason":{"type":"string","enum":["configured_category","literal_description","literal_account","configured_and_literal"]},"transactionCurrencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"transactionAmountCents":{"type":"string","pattern":"^-?\\d+$"},"baseAmountCents":{"type":["string","null"],"pattern":"^-?\\d+$"}},"required":["kind","recordId","customerId","customerName","counterpartyStatus","postedDay","documentNumber","description","ledgerAccountId","ledgerAccountName","ledgerAccountPath","costCategoryId","matchReason","transactionCurrencyCode","transactionAmountCents","baseAmountCents"],"additionalProperties":false}},"totals":{"type":"object","properties":{"grossChargeBaseCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"matchedCreditBaseCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"netChargeBaseCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"configuredMatchCount":{"type":"integer","minimum":0},"literalMatchCount":{"type":"integer","minimum":0},"bothMatchCount":{"type":"integer","minimum":0}},"required":["grossChargeBaseCents","matchedCreditBaseCents","netChargeBaseCents","configuredMatchCount","literalMatchCount","bothMatchCount"],"additionalProperties":false},"meta":{"type":"object","properties":{"sourcePopulationCount":{"type":"integer","minimum":0},"resultPopulationCount":{"type":"integer","minimum":0},"totalGroups":{"type":"integer","minimum":0},"returnedGroups":{"type":"integer","minimum":0},"truncated":{"type":"boolean"},"limit":{"type":"integer","exclusiveMinimum":0},"offset":{"type":"number","enum":[0]},"ordering":{"type":"string","minLength":1,"maxLength":500},"observedAt":{"type":"string","format":"date-time"},"evidenceComplete":{"type":"boolean"},"coverage":{"type":"object","properties":{"matchingRows":{"type":"integer","minimum":0},"missingBaseRows":{"type":"integer","minimum":0},"uncategorizedRows":{"type":"integer","minimum":0}},"required":["matchingRows","missingBaseRows","uncategorizedRows"],"additionalProperties":false}},"required":["sourcePopulationCount","resultPopulationCount","totalGroups","returnedGroups","truncated","limit","offset","ordering","observedAt","evidenceComplete","coverage"],"additionalProperties":false},"report":{"type":"object","properties":{"key":{"type":"string","enum":["customer-invoice-charges"]},"title":{"type":"string"},"description":{"type":"string"},"params":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"required":{"type":"boolean"},"description":{"type":"string"},"values":{"type":"array","items":{"type":"string"}},"defaultValue":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}}]}},"required":["name","required","description"],"additionalProperties":false}},"dimensions":{"type":"array","items":{"type":"string"}},"measures":{"type":"array","items":{"type":"string"}},"requiredScope":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]},"requiredScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"allowedForThisKey":{"type":"boolean"}},"required":["key","title","description","params","dimensions","measures","requiredScope","allowedForThisKey"],"additionalProperties":false}},"required":["params","basis","rows","totals","meta","report"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}]}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/notes":{"get":{"operationId":"listPublicAPINotes","summary":"List notes for a visible subject","description":"Returns metadata-only CRM notes for one visible customer, supplier, or product subject. Optional happenedAtFrom/happenedAtTo organization-calendar days and noteType narrow the list. This is not a global note search.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"notes:read","parameters":[{"schema":{"type":"string","enum":["customer","supplier","product"]},"required":true,"name":"primarySubjectType","in":"query"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"primarySubjectId","in":"query"},{"schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"required":false,"name":"happenedAtFrom","in":"query"},{"schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"required":false,"name":"happenedAtTo","in":"query"},{"schema":{"type":"string","enum":["PHONE_MEETING","PHYSICAL_MEETING","VIRTUAL_MEETING","NOTE","EMAIL","SAMPLE_REQUEST","OPPORTUNITY","QUOTE"]},"required":false,"name":"noteType","in":"query"},{"schema":{"type":"string","minLength":1,"maxLength":120},"required":false,"name":"externalId","in":"query"},{"schema":{"type":"string"},"required":false,"name":"limit","in":"query"}],"responses":{"200":{"description":"Subject-scoped note summaries.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["note"]},"url":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"object","properties":{"type":{"type":"string","enum":["user"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"noteType":{"type":"string","enum":["PHONE_MEETING","PHYSICAL_MEETING","VIRTUAL_MEETING","NOTE","EMAIL","SAMPLE_REQUEST","OPPORTUNITY","QUOTE"]},"title":{"type":"string"},"externalId":{"type":["string","null"]},"happenedAt":{"type":"string","format":"date-time"},"primarySubject":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["customer"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["supplier"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["product"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["redacted"]},"recordType":{"type":"string","enum":["customer","supplier","product"]}},"required":["type","recordType"],"additionalProperties":false}]},"linkedRecords":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["customer"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["supplier"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["product"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["contact"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["location"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["user"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["redacted"]},"recordType":{"type":"string","enum":["customer","supplier","product","contact","location"]}},"required":["type","recordType"],"additionalProperties":false}]}},"apiCreated":{"type":"boolean"}},"required":["id","type","url","createdAt","updatedAt","createdBy","noteType","title","externalId","happenedAt","primarySubject","linkedRecords","apiCreated"],"additionalProperties":false}},"meta":{"type":"object","properties":{"requestId":{"type":"string"},"mode":{"type":"string"},"limit":{"type":"integer"},"hasMore":{"type":"boolean"},"filters":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"changedRecordBasis":{"type":"string","enum":["parent_updated_at"]},"narrowingHints":{"type":"array","items":{"type":"string"}}},"required":["requestId","mode","limit","hasMore","filters"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}},"post":{"operationId":"createPublicAPINote","summary":"Create a public API note","description":"Creates a note on a customer, supplier, or product and links any supported related records, including organization users, who are notified. Execute requests require Idempotency-Key. dryRun=true may omit Idempotency-Key and returns a blocked readiness check instead of writing.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"notes:write","parameters":[{"schema":{"type":"string","enum":["true"]},"required":false,"name":"dryRun","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Required for execute requests. dryRun=true may omit this header and receive an idempotency_key_required check."},"required":false,"description":"Required for execute requests. dryRun=true may omit this header and receive an idempotency_key_required check.","name":"Idempotency-Key","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"primarySubject":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","product"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},"linkedRecords":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","product","contact","location","user"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},"maxItems":50,"default":[]},"noteType":{"type":"string","enum":["PHONE_MEETING","PHYSICAL_MEETING","VIRTUAL_MEETING","NOTE","EMAIL","SAMPLE_REQUEST","OPPORTUNITY","QUOTE"]},"title":{"type":"string","minLength":1,"maxLength":240},"body":{"type":"string","minLength":1,"maxLength":20000},"happenedAt":{"type":"string","format":"date-time"},"externalId":{"type":["string","null"],"maxLength":120}},"required":["primarySubject","noteType","title","body","happenedAt"],"additionalProperties":false}}}},"responses":{"200":{"description":"Idempotent replay returned the existing note, or dryRun returned write readiness.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["note"]},"url":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"object","properties":{"type":{"type":"string","enum":["user"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"createdVia":{"type":["object","null"],"properties":{"type":{"type":"string","enum":["public_api"]},"actorUserId":{"type":"string","format":"uuid"}},"required":["type","actorUserId"],"additionalProperties":false},"requestedVia":{"type":"object","properties":{"type":{"type":"string","enum":["api_key"]},"id":{"type":"string","format":"uuid"},"purpose":{"type":["string","null"]}},"required":["type","id","purpose"],"additionalProperties":false},"noteType":{"type":"string","enum":["PHONE_MEETING","PHYSICAL_MEETING","VIRTUAL_MEETING","NOTE","EMAIL","SAMPLE_REQUEST","OPPORTUNITY","QUOTE"]},"title":{"type":"string"},"body":{"type":"string"},"happenedAt":{"type":"string","format":"date-time"},"primarySubject":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["customer"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["supplier"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["product"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["redacted"]},"recordType":{"type":"string","enum":["customer","supplier","product"]}},"required":["type","recordType"],"additionalProperties":false}]},"linkedRecords":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["customer"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["supplier"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["product"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["contact"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["location"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["user"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["redacted"]},"recordType":{"type":"string","enum":["customer","supplier","product","contact","location"]}},"required":["type","recordType"],"additionalProperties":false}]}},"externalId":{"type":["string","null"]},"idempotencyStatus":{"type":"string","enum":["created","replayed","updated","fetched"]}},"required":["id","type","url","createdAt","updatedAt","createdBy","createdVia","requestedVia","noteType","title","body","happenedAt","primarySubject","linkedRecords","externalId","idempotencyStatus"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["write_readiness"]},"operation":{"type":"string","enum":["warehouses.create","warehouses.update","warehouses.archive","warehouses.unarchive","shipping_options.create","shipping_options.update","shipping_options.archive","shipping_options.unarchive","reorder_points.create","tags.create","tags.update","tag_assignments.create","tag_assignments.delete","notes.create","notes.update","opportunities.create","opportunities.update","opportunities.close","opportunities.meta-upsert","contacts.create","contacts.update","customers.create","customers.update","customer_locations.create","customer_locations.update","customer_addresses.create","customer_addresses.update","suppliers.create","suppliers.update","supplier_ship_from_locations.create","supplier_ship_from_locations.update","products.create","products.update","products.archive","products.unarchive","product_packaging.create","products.suppliers.create","products.suppliers.delete","products.aliases.create","products.aliases.update","products.aliases.delete","product_families.aliases.create","product_families.aliases.update","product_families.aliases.delete","products.customer_part_numbers.create","products.customer_part_numbers.update","products.customer_part_numbers.delete","product_sds.update","product_documents.create","customer_documents.create","supplier_documents.create","purchase_order_documents.create","product_families.create","product_families.update","cost_book_entries.create","current_cost_sources.put","customers.archive","customers.unarchive","suppliers.archive","suppliers.unarchive","contacts.archive","contacts.unarchive","customer_addresses.archive","customer_addresses.unarchive","supplier_ship_from_locations.archive","supplier_ship_from_locations.unarchive","representatives.create","representatives.update","representatives.archive","representatives.unarchive","payment_terms.create","payment_terms.update","ledger_accounts.create","ledger_accounts.update"]},"status":{"type":"string","enum":["ready","blocked"]},"wouldWrite":{"type":"boolean","enum":[false]},"submit":{"type":"object","properties":{"method":{"type":"string","enum":["POST","PATCH","PUT","DELETE"]},"path":{"type":"string"},"query":{"type":"object","properties":{},"additionalProperties":false}},"required":["method","path","query"],"additionalProperties":false},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false},"checks":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["not_direct_ship","address_role_required","address_role_valid","already_assigned","already_exists","active_duplicate","ambiguous_external_id","ambiguous_natural_key","api_created","archived_target","archived_record","archive_blocked","account_type_locked","duplicate_candidate_found","duplicate_candidate_overflow","duplicate_check_clear","duplicate_check_not_needed","duplicate_contact","duplicate_customer","duplicate_customer_address","duplicate_customer_location","duplicate_note","duplicate_resolution_applied","duplicate_supplier","duplicate_supplier_ship_from_location","document_url_org_scoped","document_url_valid","upload_verified","sds_converged","idempotency_available","idempotency_key_required","idempotency_key_reused","idempotency_replay","idempotency_target_missing","income_statement_type_invalid","hard_identity_clear","nested_external_id_clear","commercial_references_valid","credit_denomination_mismatch","customer_service_representative_reference_active","ledger_account_reference_valid","payment_terms_reference_exists","sales_person_reference_active","supplier_representative_reference_active","duplicate_reference_identity","external_id_conflict","if_match_current","base_uom_transition_allowed","base_uom_transition_blocked","attribute_assignments_valid","attribute_assignments_invalid","selected_supplier_link","linked_records_available","natural_key_conflict","not_api_created","no_downstream_mutation","order_sensitive_update_allowed","order_sensitive_update_blocked","parent_available","cost_book_entry_blocked","cost_book_entry_valid","cost_book_reference_not_visible","unsupported_cost_book_uom","cost_uom_conversion_unavailable","cost_book_base_unavailable","cost_book_base_ambiguous","cost_ship_from_location_not_visible","cost_package_quantity_invalid","cost_component_invalid","cost_date_window_invalid","cost_date_overlap","cost_amount_overflow","cost_book_conflict","product_family_reference_active","product_packaging_reference_active","primary_child_available","primary_change_unsupported","reference_visibility_blocked","scope_authorized","stale_record","stale_cost_book_entry","supplier_reference_active","tag_applicable","tag_available","tag_exists","tag_found","tag_not_applicable","tag_not_found","type_immutable","type_known","type_required","target_active","target_available","target_not_found_or_not_visible","targets_visible","unsupported_linked_record","unsupported_profile_shape","variable_qty_valid","validation_failed","value_nonempty"]},"status":{"type":"string","enum":["passed","blocked"]},"message":{"type":"string"},"param":{"type":"string"}},"required":["code","status","message"],"additionalProperties":false}},"duplicateCandidates":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact","customer","supplier","customer_location","customer_address","supplier_ship_from_location","product","product_family","document"]},"readable":{"type":"boolean"},"version":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","product","purchase_order"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"matchReasons":{"type":"array","items":{"type":"string","enum":["name","email","externalId","address","code","product","url"]}},"readbackPath":{"type":"string"}},"required":["type","readable","matchReasons"],"additionalProperties":false}},"idempotency":{"type":"object","properties":{"required":{"type":"boolean"},"keyProvided":{"type":"boolean"},"wouldReplay":{"type":"boolean"}},"required":["required","keyProvided","wouldReplay"],"additionalProperties":false},"wouldChange":{"type":"object","properties":{"fieldNames":{"type":"array","items":{"type":"string"}},"values":{"type":"object","additionalProperties":{}}},"required":["fieldNames","values"],"additionalProperties":false},"impactAnalysis":{"type":"object","additionalProperties":{}},"requestId":{"type":"string"}},"required":["type","operation","status","wouldWrite","submit","verification","checks","duplicateCandidates","requestId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}]}}}},"201":{"description":"Note created.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["note"]},"url":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"object","properties":{"type":{"type":"string","enum":["user"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"createdVia":{"type":["object","null"],"properties":{"type":{"type":"string","enum":["public_api"]},"actorUserId":{"type":"string","format":"uuid"}},"required":["type","actorUserId"],"additionalProperties":false},"requestedVia":{"type":"object","properties":{"type":{"type":"string","enum":["api_key"]},"id":{"type":"string","format":"uuid"},"purpose":{"type":["string","null"]}},"required":["type","id","purpose"],"additionalProperties":false},"noteType":{"type":"string","enum":["PHONE_MEETING","PHYSICAL_MEETING","VIRTUAL_MEETING","NOTE","EMAIL","SAMPLE_REQUEST","OPPORTUNITY","QUOTE"]},"title":{"type":"string"},"body":{"type":"string"},"happenedAt":{"type":"string","format":"date-time"},"primarySubject":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["customer"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["supplier"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["product"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["redacted"]},"recordType":{"type":"string","enum":["customer","supplier","product"]}},"required":["type","recordType"],"additionalProperties":false}]},"linkedRecords":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["customer"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["supplier"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["product"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["contact"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["location"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["user"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["redacted"]},"recordType":{"type":"string","enum":["customer","supplier","product","contact","location"]}},"required":["type","recordType"],"additionalProperties":false}]}},"externalId":{"type":["string","null"]},"idempotencyStatus":{"type":"string","enum":["created","replayed","updated","fetched"]}},"required":["id","type","url","createdAt","updatedAt","createdBy","createdVia","requestedVia","noteType","title","body","happenedAt","primarySubject","linkedRecords","externalId","idempotencyStatus"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested parent or record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"409":{"description":"The write conflicted with an existing record, idempotency payload, or stale If-Match value.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/opportunities":{"get":{"operationId":"listPublicAPIOpportunities","summary":"List authorized opportunities","description":"Returns customer- and supplier-side opportunities visible to the acting user under deny-by-default aspect authorization. Estimates are exact stored values with explicit currency labels, not revenue, probability, forecast, or accounting truth. The closed sort is updatedAt asc or desc with id ascending as the tie-breaker. Signed cursors bind the organization, API key, normalized filters, sort, and page size.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"opportunities:read","parameters":[{"schema":{"type":"string","minLength":1,"maxLength":240},"required":false,"name":"query","in":"query"},{"schema":{"type":["array","null"],"items":{"type":"string","enum":["LEAD","IN_PROGRESS","CLOSED"]},"maxItems":3},"required":false,"name":"status","in":"query"},{"schema":{"type":"string","format":"uuid"},"required":false,"name":"customerId","in":"query"},{"schema":{"type":"string","format":"uuid"},"required":false,"name":"supplierId","in":"query"},{"schema":{"type":["array","null"],"items":{"type":"string","format":"uuid"},"maxItems":100},"required":false,"name":"assignedToId","in":"query"},{"schema":{"type":"string","format":"uuid"},"required":false,"name":"productId","in":"query"},{"schema":{"type":"string","format":"uuid"},"required":false,"name":"createdById","in":"query"},{"schema":{"type":"string","format":"date-time"},"required":false,"name":"createdFrom","in":"query"},{"schema":{"type":"string","format":"date-time"},"required":false,"name":"createdTo","in":"query"},{"schema":{"type":"string","enum":["updatedAt"]},"required":false,"name":"sortBy","in":"query"},{"schema":{"type":"string","enum":["asc","desc"]},"required":false,"name":"sortDirection","in":"query"},{"schema":{"type":"string"},"required":false,"name":"limit","in":"query"},{"schema":{"type":"string","minLength":1},"required":false,"name":"cursor","in":"query"}],"responses":{"200":{"description":"Authorized opportunity summaries and signed continuation metadata.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["opportunity"]},"id":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["user"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["system"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string","enum":["System User"]}},"required":["type","id","displayName"],"additionalProperties":false}]},"updatedAt":{"type":"string","format":"date-time"},"closedAt":{"type":["string","null"],"format":"date-time"},"title":{"type":"string"},"description":{"type":"string"},"status":{"type":"string","enum":["LEAD","IN_PROGRESS","CLOSED"]},"successStatus":{"type":["string","null"],"enum":["WON","LOST"]},"estimatedValue":{"type":["object","null"],"properties":{"value":{"type":"string","pattern":"^\\d+(?:\\.\\d{2})$"},"kind":{"type":"string","enum":["estimate"]},"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"}},"required":["value","kind","currencyCode"],"additionalProperties":false},"source":{"type":"string","enum":["UI","PUBLIC_API","TRANSCRIPT","IMPORT"]},"assignedTo":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false},"relationships":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"customer":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"pipelineStatus":{"type":"string"}},"required":["id","name","pipelineStatus"],"additionalProperties":false}},"required":["customer"],"additionalProperties":false},{"type":"object","properties":{"supplier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false}},"required":["supplier"],"additionalProperties":false}]}},"products":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"code":{"type":"string"}},"required":["id","code"],"additionalProperties":false}},"createdVia":{"type":["object","null"],"properties":{"type":{"type":"string","enum":["public_api"]},"actorUserId":{"type":"string","format":"uuid"}},"required":["type","actorUserId"],"additionalProperties":false},"requestedVia":{"type":"object","properties":{"type":{"type":"string","enum":["api_key"]},"id":{"type":"string","format":"uuid"},"purpose":{"type":["string","null"]}},"required":["type","id","purpose"],"additionalProperties":false}},"required":["type","id","createdAt","createdBy","updatedAt","closedAt","title","description","status","successStatus","estimatedValue","source","assignedTo","relationships","products","createdVia","requestedVia"],"additionalProperties":false}},"meta":{"type":"object","properties":{"limit":{"type":"integer","exclusiveMinimum":0},"total":{"type":"integer","minimum":0},"nextCursor":{"type":["string","null"]}},"required":["limit","total","nextCursor"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}},"post":{"operationId":"createPublicAPIOpportunity","summary":"Create an opportunity","description":"Creates an opportunity for exactly one existing customer or supplier. Execute requests require Idempotency-Key. dryRun=true may omit Idempotency-Key and returns a blocked readiness check instead of writing. The server stamps PUBLIC_API provenance, the API key id, and the organization's base currency as immutable estimate denomination. Product and assignee references must be active, organization-scoped, and visible to the actor.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"opportunities:write","parameters":[{"schema":{"type":"string","enum":["true"]},"required":false,"name":"dryRun","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Required for execute requests. dryRun=true may omit this header and receive an idempotency_key_required check."},"required":false,"description":"Required for execute requests. dryRun=true may omit this header and receive an idempotency_key_required check.","name":"Idempotency-Key","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","minLength":1,"maxLength":240},"description":{"type":"string","maxLength":20000},"customerId":{"type":"string","format":"uuid"},"supplierId":{"type":"string","format":"uuid"},"estimatedValue":{"type":["number","null"],"minimum":0,"maximum":9999999999999.99},"assignedToId":{"type":"string","format":"uuid"},"productIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":100}},"required":["title"],"additionalProperties":false}}}},"responses":{"200":{"description":"Idempotent replay returned the durable prior opportunity, or dryRun returned write readiness.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["opportunity"]},"id":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["user"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["system"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string","enum":["System User"]}},"required":["type","id","displayName"],"additionalProperties":false}]},"updatedAt":{"type":"string","format":"date-time"},"closedAt":{"type":["string","null"],"format":"date-time"},"title":{"type":"string"},"description":{"type":"string"},"status":{"type":"string","enum":["LEAD","IN_PROGRESS","CLOSED"]},"successStatus":{"type":["string","null"],"enum":["WON","LOST"]},"estimatedValue":{"type":["object","null"],"properties":{"value":{"type":"string","pattern":"^\\d+(?:\\.\\d{2})$"},"kind":{"type":"string","enum":["estimate"]},"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"}},"required":["value","kind","currencyCode"],"additionalProperties":false},"source":{"type":"string","enum":["UI","PUBLIC_API","TRANSCRIPT","IMPORT"]},"assignedTo":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false},"relationships":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"customer":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"pipelineStatus":{"type":"string"}},"required":["id","name","pipelineStatus"],"additionalProperties":false}},"required":["customer"],"additionalProperties":false},{"type":"object","properties":{"supplier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false}},"required":["supplier"],"additionalProperties":false}]}},"products":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"code":{"type":"string"}},"required":["id","code"],"additionalProperties":false}},"createdVia":{"type":["object","null"],"properties":{"type":{"type":"string","enum":["public_api"]},"actorUserId":{"type":"string","format":"uuid"}},"required":["type","actorUserId"],"additionalProperties":false},"requestedVia":{"type":"object","properties":{"type":{"type":"string","enum":["api_key"]},"id":{"type":"string","format":"uuid"},"purpose":{"type":["string","null"]}},"required":["type","id","purpose"],"additionalProperties":false},"closingNotes":{"type":["string","null"]},"sourceDetail":{"type":["string","null"]},"meta":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"}},"required":["key","value","updatedAt"],"additionalProperties":false}},"timeline":{"type":"array","items":{"type":"object","properties":{"eventType":{"type":"string"},"createdAt":{"type":"string","format":"date-time"}},"required":["eventType","createdAt"],"additionalProperties":false},"maxItems":100},"timelineCoverage":{"type":"object","properties":{"status":{"type":"string","enum":["complete","bounded"]},"limit":{"type":"number","enum":[100]}},"required":["status","limit"],"additionalProperties":false},"statusIntegrity":{"type":"string","enum":["valid","legacy_closed_without_outcome"]},"idempotencyStatus":{"type":"string","enum":["created","replayed","updated","closed","meta_updated","fetched"]}},"required":["type","id","createdAt","createdBy","updatedAt","closedAt","title","description","status","successStatus","estimatedValue","source","assignedTo","relationships","products","createdVia","requestedVia","closingNotes","sourceDetail","meta","timeline","timelineCoverage","statusIntegrity","idempotencyStatus"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["write_readiness"]},"operation":{"type":"string","enum":["warehouses.create","warehouses.update","warehouses.archive","warehouses.unarchive","shipping_options.create","shipping_options.update","shipping_options.archive","shipping_options.unarchive","reorder_points.create","tags.create","tags.update","tag_assignments.create","tag_assignments.delete","notes.create","notes.update","opportunities.create","opportunities.update","opportunities.close","opportunities.meta-upsert","contacts.create","contacts.update","customers.create","customers.update","customer_locations.create","customer_locations.update","customer_addresses.create","customer_addresses.update","suppliers.create","suppliers.update","supplier_ship_from_locations.create","supplier_ship_from_locations.update","products.create","products.update","products.archive","products.unarchive","product_packaging.create","products.suppliers.create","products.suppliers.delete","products.aliases.create","products.aliases.update","products.aliases.delete","product_families.aliases.create","product_families.aliases.update","product_families.aliases.delete","products.customer_part_numbers.create","products.customer_part_numbers.update","products.customer_part_numbers.delete","product_sds.update","product_documents.create","customer_documents.create","supplier_documents.create","purchase_order_documents.create","product_families.create","product_families.update","cost_book_entries.create","current_cost_sources.put","customers.archive","customers.unarchive","suppliers.archive","suppliers.unarchive","contacts.archive","contacts.unarchive","customer_addresses.archive","customer_addresses.unarchive","supplier_ship_from_locations.archive","supplier_ship_from_locations.unarchive","representatives.create","representatives.update","representatives.archive","representatives.unarchive","payment_terms.create","payment_terms.update","ledger_accounts.create","ledger_accounts.update"]},"status":{"type":"string","enum":["ready","blocked"]},"wouldWrite":{"type":"boolean","enum":[false]},"submit":{"type":"object","properties":{"method":{"type":"string","enum":["POST","PATCH","PUT","DELETE"]},"path":{"type":"string"},"query":{"type":"object","properties":{},"additionalProperties":false}},"required":["method","path","query"],"additionalProperties":false},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false},"checks":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["not_direct_ship","address_role_required","address_role_valid","already_assigned","already_exists","active_duplicate","ambiguous_external_id","ambiguous_natural_key","api_created","archived_target","archived_record","archive_blocked","account_type_locked","duplicate_candidate_found","duplicate_candidate_overflow","duplicate_check_clear","duplicate_check_not_needed","duplicate_contact","duplicate_customer","duplicate_customer_address","duplicate_customer_location","duplicate_note","duplicate_resolution_applied","duplicate_supplier","duplicate_supplier_ship_from_location","document_url_org_scoped","document_url_valid","upload_verified","sds_converged","idempotency_available","idempotency_key_required","idempotency_key_reused","idempotency_replay","idempotency_target_missing","income_statement_type_invalid","hard_identity_clear","nested_external_id_clear","commercial_references_valid","credit_denomination_mismatch","customer_service_representative_reference_active","ledger_account_reference_valid","payment_terms_reference_exists","sales_person_reference_active","supplier_representative_reference_active","duplicate_reference_identity","external_id_conflict","if_match_current","base_uom_transition_allowed","base_uom_transition_blocked","attribute_assignments_valid","attribute_assignments_invalid","selected_supplier_link","linked_records_available","natural_key_conflict","not_api_created","no_downstream_mutation","order_sensitive_update_allowed","order_sensitive_update_blocked","parent_available","cost_book_entry_blocked","cost_book_entry_valid","cost_book_reference_not_visible","unsupported_cost_book_uom","cost_uom_conversion_unavailable","cost_book_base_unavailable","cost_book_base_ambiguous","cost_ship_from_location_not_visible","cost_package_quantity_invalid","cost_component_invalid","cost_date_window_invalid","cost_date_overlap","cost_amount_overflow","cost_book_conflict","product_family_reference_active","product_packaging_reference_active","primary_child_available","primary_change_unsupported","reference_visibility_blocked","scope_authorized","stale_record","stale_cost_book_entry","supplier_reference_active","tag_applicable","tag_available","tag_exists","tag_found","tag_not_applicable","tag_not_found","type_immutable","type_known","type_required","target_active","target_available","target_not_found_or_not_visible","targets_visible","unsupported_linked_record","unsupported_profile_shape","variable_qty_valid","validation_failed","value_nonempty"]},"status":{"type":"string","enum":["passed","blocked"]},"message":{"type":"string"},"param":{"type":"string"}},"required":["code","status","message"],"additionalProperties":false}},"duplicateCandidates":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact","customer","supplier","customer_location","customer_address","supplier_ship_from_location","product","product_family","document"]},"readable":{"type":"boolean"},"version":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","product","purchase_order"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"matchReasons":{"type":"array","items":{"type":"string","enum":["name","email","externalId","address","code","product","url"]}},"readbackPath":{"type":"string"}},"required":["type","readable","matchReasons"],"additionalProperties":false}},"idempotency":{"type":"object","properties":{"required":{"type":"boolean"},"keyProvided":{"type":"boolean"},"wouldReplay":{"type":"boolean"}},"required":["required","keyProvided","wouldReplay"],"additionalProperties":false},"wouldChange":{"type":"object","properties":{"fieldNames":{"type":"array","items":{"type":"string"}},"values":{"type":"object","additionalProperties":{}}},"required":["fieldNames","values"],"additionalProperties":false},"impactAnalysis":{"type":"object","additionalProperties":{}},"requestId":{"type":"string"}},"required":["type","operation","status","wouldWrite","submit","verification","checks","duplicateCandidates","requestId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}]}}}},"201":{"description":"Opportunity created.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["opportunity"]},"id":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["user"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["system"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string","enum":["System User"]}},"required":["type","id","displayName"],"additionalProperties":false}]},"updatedAt":{"type":"string","format":"date-time"},"closedAt":{"type":["string","null"],"format":"date-time"},"title":{"type":"string"},"description":{"type":"string"},"status":{"type":"string","enum":["LEAD","IN_PROGRESS","CLOSED"]},"successStatus":{"type":["string","null"],"enum":["WON","LOST"]},"estimatedValue":{"type":["object","null"],"properties":{"value":{"type":"string","pattern":"^\\d+(?:\\.\\d{2})$"},"kind":{"type":"string","enum":["estimate"]},"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"}},"required":["value","kind","currencyCode"],"additionalProperties":false},"source":{"type":"string","enum":["UI","PUBLIC_API","TRANSCRIPT","IMPORT"]},"assignedTo":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false},"relationships":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"customer":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"pipelineStatus":{"type":"string"}},"required":["id","name","pipelineStatus"],"additionalProperties":false}},"required":["customer"],"additionalProperties":false},{"type":"object","properties":{"supplier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false}},"required":["supplier"],"additionalProperties":false}]}},"products":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"code":{"type":"string"}},"required":["id","code"],"additionalProperties":false}},"createdVia":{"type":["object","null"],"properties":{"type":{"type":"string","enum":["public_api"]},"actorUserId":{"type":"string","format":"uuid"}},"required":["type","actorUserId"],"additionalProperties":false},"requestedVia":{"type":"object","properties":{"type":{"type":"string","enum":["api_key"]},"id":{"type":"string","format":"uuid"},"purpose":{"type":["string","null"]}},"required":["type","id","purpose"],"additionalProperties":false},"closingNotes":{"type":["string","null"]},"sourceDetail":{"type":["string","null"]},"meta":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"}},"required":["key","value","updatedAt"],"additionalProperties":false}},"timeline":{"type":"array","items":{"type":"object","properties":{"eventType":{"type":"string"},"createdAt":{"type":"string","format":"date-time"}},"required":["eventType","createdAt"],"additionalProperties":false},"maxItems":100},"timelineCoverage":{"type":"object","properties":{"status":{"type":"string","enum":["complete","bounded"]},"limit":{"type":"number","enum":[100]}},"required":["status","limit"],"additionalProperties":false},"statusIntegrity":{"type":"string","enum":["valid","legacy_closed_without_outcome"]},"idempotencyStatus":{"type":"string","enum":["created","replayed","updated","closed","meta_updated","fetched"]}},"required":["type","id","createdAt","createdBy","updatedAt","closedAt","title","description","status","successStatus","estimatedValue","source","assignedTo","relationships","products","createdVia","requestedVia","closingNotes","sourceDetail","meta","timeline","timelineCoverage","statusIntegrity","idempotencyStatus"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested parent or record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"409":{"description":"The write conflicted with an existing record, idempotency payload, or stale If-Match value.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/opportunities/{id}":{"get":{"operationId":"getPublicAPIOpportunity","summary":"Get opportunity detail","description":"Returns one visible opportunity with metadata, products, and the newest 100 typed timeline events. Event text is never exposed. An invisible opportunity is indistinguishable from an absent record.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":["opportunities:read","opportunities:write"],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Authorized opportunity detail.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["opportunity"]},"id":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["user"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["system"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string","enum":["System User"]}},"required":["type","id","displayName"],"additionalProperties":false}]},"updatedAt":{"type":"string","format":"date-time"},"closedAt":{"type":["string","null"],"format":"date-time"},"title":{"type":"string"},"description":{"type":"string"},"status":{"type":"string","enum":["LEAD","IN_PROGRESS","CLOSED"]},"successStatus":{"type":["string","null"],"enum":["WON","LOST"]},"estimatedValue":{"type":["object","null"],"properties":{"value":{"type":"string","pattern":"^\\d+(?:\\.\\d{2})$"},"kind":{"type":"string","enum":["estimate"]},"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"}},"required":["value","kind","currencyCode"],"additionalProperties":false},"source":{"type":"string","enum":["UI","PUBLIC_API","TRANSCRIPT","IMPORT"]},"assignedTo":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false},"relationships":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"customer":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"pipelineStatus":{"type":"string"}},"required":["id","name","pipelineStatus"],"additionalProperties":false}},"required":["customer"],"additionalProperties":false},{"type":"object","properties":{"supplier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false}},"required":["supplier"],"additionalProperties":false}]}},"products":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"code":{"type":"string"}},"required":["id","code"],"additionalProperties":false}},"createdVia":{"type":["object","null"],"properties":{"type":{"type":"string","enum":["public_api"]},"actorUserId":{"type":"string","format":"uuid"}},"required":["type","actorUserId"],"additionalProperties":false},"requestedVia":{"type":"object","properties":{"type":{"type":"string","enum":["api_key"]},"id":{"type":"string","format":"uuid"},"purpose":{"type":["string","null"]}},"required":["type","id","purpose"],"additionalProperties":false},"closingNotes":{"type":["string","null"]},"sourceDetail":{"type":["string","null"]},"meta":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"}},"required":["key","value","updatedAt"],"additionalProperties":false}},"timeline":{"type":"array","items":{"type":"object","properties":{"eventType":{"type":"string"},"createdAt":{"type":"string","format":"date-time"}},"required":["eventType","createdAt"],"additionalProperties":false},"maxItems":100},"timelineCoverage":{"type":"object","properties":{"status":{"type":"string","enum":["complete","bounded"]},"limit":{"type":"number","enum":[100]}},"required":["status","limit"],"additionalProperties":false},"statusIntegrity":{"type":"string","enum":["valid","legacy_closed_without_outcome"]},"idempotencyStatus":{"type":"string","enum":["created","replayed","updated","closed","meta_updated","fetched"]}},"required":["type","id","createdAt","createdBy","updatedAt","closedAt","title","description","status","successStatus","estimatedValue","source","assignedTo","relationships","products","createdVia","requestedVia","closingNotes","sourceDetail","meta","timeline","timelineCoverage","statusIntegrity","idempotencyStatus"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updatePublicAPIOpportunity","summary":"Update an open opportunity","description":"Updates an open opportunity. Execute requests require If-Match. dryRun=true may omit If-Match and returns a blocked readiness check instead of writing. Execute requires current updatedAt in If-Match. PATCH may set LEAD or IN_PROGRESS, cannot close or reopen, and cannot change estimate currency.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"opportunities:write","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","enum":["true"]},"required":false,"name":"dryRun","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check."},"required":false,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check.","name":"If-Match","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","minLength":1,"maxLength":240},"description":{"type":"string","maxLength":20000},"estimatedValue":{"type":["number","null"],"minimum":0,"maximum":9999999999999.99},"assignedToId":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["LEAD","IN_PROGRESS"]}},"additionalProperties":false}}}},"responses":{"200":{"description":"Updated opportunity detail, or dryRun returned write readiness.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["opportunity"]},"id":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["user"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["system"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string","enum":["System User"]}},"required":["type","id","displayName"],"additionalProperties":false}]},"updatedAt":{"type":"string","format":"date-time"},"closedAt":{"type":["string","null"],"format":"date-time"},"title":{"type":"string"},"description":{"type":"string"},"status":{"type":"string","enum":["LEAD","IN_PROGRESS","CLOSED"]},"successStatus":{"type":["string","null"],"enum":["WON","LOST"]},"estimatedValue":{"type":["object","null"],"properties":{"value":{"type":"string","pattern":"^\\d+(?:\\.\\d{2})$"},"kind":{"type":"string","enum":["estimate"]},"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"}},"required":["value","kind","currencyCode"],"additionalProperties":false},"source":{"type":"string","enum":["UI","PUBLIC_API","TRANSCRIPT","IMPORT"]},"assignedTo":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false},"relationships":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"customer":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"pipelineStatus":{"type":"string"}},"required":["id","name","pipelineStatus"],"additionalProperties":false}},"required":["customer"],"additionalProperties":false},{"type":"object","properties":{"supplier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false}},"required":["supplier"],"additionalProperties":false}]}},"products":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"code":{"type":"string"}},"required":["id","code"],"additionalProperties":false}},"createdVia":{"type":["object","null"],"properties":{"type":{"type":"string","enum":["public_api"]},"actorUserId":{"type":"string","format":"uuid"}},"required":["type","actorUserId"],"additionalProperties":false},"requestedVia":{"type":"object","properties":{"type":{"type":"string","enum":["api_key"]},"id":{"type":"string","format":"uuid"},"purpose":{"type":["string","null"]}},"required":["type","id","purpose"],"additionalProperties":false},"closingNotes":{"type":["string","null"]},"sourceDetail":{"type":["string","null"]},"meta":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"}},"required":["key","value","updatedAt"],"additionalProperties":false}},"timeline":{"type":"array","items":{"type":"object","properties":{"eventType":{"type":"string"},"createdAt":{"type":"string","format":"date-time"}},"required":["eventType","createdAt"],"additionalProperties":false},"maxItems":100},"timelineCoverage":{"type":"object","properties":{"status":{"type":"string","enum":["complete","bounded"]},"limit":{"type":"number","enum":[100]}},"required":["status","limit"],"additionalProperties":false},"statusIntegrity":{"type":"string","enum":["valid","legacy_closed_without_outcome"]},"idempotencyStatus":{"type":"string","enum":["created","replayed","updated","closed","meta_updated","fetched"]}},"required":["type","id","createdAt","createdBy","updatedAt","closedAt","title","description","status","successStatus","estimatedValue","source","assignedTo","relationships","products","createdVia","requestedVia","closingNotes","sourceDetail","meta","timeline","timelineCoverage","statusIntegrity","idempotencyStatus"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["write_readiness"]},"operation":{"type":"string","enum":["warehouses.create","warehouses.update","warehouses.archive","warehouses.unarchive","shipping_options.create","shipping_options.update","shipping_options.archive","shipping_options.unarchive","reorder_points.create","tags.create","tags.update","tag_assignments.create","tag_assignments.delete","notes.create","notes.update","opportunities.create","opportunities.update","opportunities.close","opportunities.meta-upsert","contacts.create","contacts.update","customers.create","customers.update","customer_locations.create","customer_locations.update","customer_addresses.create","customer_addresses.update","suppliers.create","suppliers.update","supplier_ship_from_locations.create","supplier_ship_from_locations.update","products.create","products.update","products.archive","products.unarchive","product_packaging.create","products.suppliers.create","products.suppliers.delete","products.aliases.create","products.aliases.update","products.aliases.delete","product_families.aliases.create","product_families.aliases.update","product_families.aliases.delete","products.customer_part_numbers.create","products.customer_part_numbers.update","products.customer_part_numbers.delete","product_sds.update","product_documents.create","customer_documents.create","supplier_documents.create","purchase_order_documents.create","product_families.create","product_families.update","cost_book_entries.create","current_cost_sources.put","customers.archive","customers.unarchive","suppliers.archive","suppliers.unarchive","contacts.archive","contacts.unarchive","customer_addresses.archive","customer_addresses.unarchive","supplier_ship_from_locations.archive","supplier_ship_from_locations.unarchive","representatives.create","representatives.update","representatives.archive","representatives.unarchive","payment_terms.create","payment_terms.update","ledger_accounts.create","ledger_accounts.update"]},"status":{"type":"string","enum":["ready","blocked"]},"wouldWrite":{"type":"boolean","enum":[false]},"submit":{"type":"object","properties":{"method":{"type":"string","enum":["POST","PATCH","PUT","DELETE"]},"path":{"type":"string"},"query":{"type":"object","properties":{},"additionalProperties":false}},"required":["method","path","query"],"additionalProperties":false},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false},"checks":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["not_direct_ship","address_role_required","address_role_valid","already_assigned","already_exists","active_duplicate","ambiguous_external_id","ambiguous_natural_key","api_created","archived_target","archived_record","archive_blocked","account_type_locked","duplicate_candidate_found","duplicate_candidate_overflow","duplicate_check_clear","duplicate_check_not_needed","duplicate_contact","duplicate_customer","duplicate_customer_address","duplicate_customer_location","duplicate_note","duplicate_resolution_applied","duplicate_supplier","duplicate_supplier_ship_from_location","document_url_org_scoped","document_url_valid","upload_verified","sds_converged","idempotency_available","idempotency_key_required","idempotency_key_reused","idempotency_replay","idempotency_target_missing","income_statement_type_invalid","hard_identity_clear","nested_external_id_clear","commercial_references_valid","credit_denomination_mismatch","customer_service_representative_reference_active","ledger_account_reference_valid","payment_terms_reference_exists","sales_person_reference_active","supplier_representative_reference_active","duplicate_reference_identity","external_id_conflict","if_match_current","base_uom_transition_allowed","base_uom_transition_blocked","attribute_assignments_valid","attribute_assignments_invalid","selected_supplier_link","linked_records_available","natural_key_conflict","not_api_created","no_downstream_mutation","order_sensitive_update_allowed","order_sensitive_update_blocked","parent_available","cost_book_entry_blocked","cost_book_entry_valid","cost_book_reference_not_visible","unsupported_cost_book_uom","cost_uom_conversion_unavailable","cost_book_base_unavailable","cost_book_base_ambiguous","cost_ship_from_location_not_visible","cost_package_quantity_invalid","cost_component_invalid","cost_date_window_invalid","cost_date_overlap","cost_amount_overflow","cost_book_conflict","product_family_reference_active","product_packaging_reference_active","primary_child_available","primary_change_unsupported","reference_visibility_blocked","scope_authorized","stale_record","stale_cost_book_entry","supplier_reference_active","tag_applicable","tag_available","tag_exists","tag_found","tag_not_applicable","tag_not_found","type_immutable","type_known","type_required","target_active","target_available","target_not_found_or_not_visible","targets_visible","unsupported_linked_record","unsupported_profile_shape","variable_qty_valid","validation_failed","value_nonempty"]},"status":{"type":"string","enum":["passed","blocked"]},"message":{"type":"string"},"param":{"type":"string"}},"required":["code","status","message"],"additionalProperties":false}},"duplicateCandidates":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact","customer","supplier","customer_location","customer_address","supplier_ship_from_location","product","product_family","document"]},"readable":{"type":"boolean"},"version":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","product","purchase_order"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"matchReasons":{"type":"array","items":{"type":"string","enum":["name","email","externalId","address","code","product","url"]}},"readbackPath":{"type":"string"}},"required":["type","readable","matchReasons"],"additionalProperties":false}},"idempotency":{"type":"object","properties":{"required":{"type":"boolean"},"keyProvided":{"type":"boolean"},"wouldReplay":{"type":"boolean"}},"required":["required","keyProvided","wouldReplay"],"additionalProperties":false},"wouldChange":{"type":"object","properties":{"fieldNames":{"type":"array","items":{"type":"string"}},"values":{"type":"object","additionalProperties":{}}},"required":["fieldNames","values"],"additionalProperties":false},"impactAnalysis":{"type":"object","additionalProperties":{}},"requestId":{"type":"string"}},"required":["type","operation","status","wouldWrite","submit","verification","checks","duplicateCandidates","requestId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}]}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested parent or record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"409":{"description":"The write conflicted with an existing record, idempotency payload, or stale If-Match value.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/opportunities/{id}/close":{"post":{"operationId":"closePublicAPIOpportunity","summary":"Close an in-progress opportunity","description":"Closes only an IN_PROGRESS opportunity as WON or LOST. Concurrent close attempts cannot double-emit. WON preserves the existing atomic prospect-customer promotion and cross-organization outbox behavior. dryRun=true reports workflow readiness.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"opportunities:write","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","enum":["true"]},"required":false,"name":"dryRun","in":"query"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"successStatus":{"type":"string","enum":["WON","LOST"]},"closingNotes":{"type":"string","maxLength":20000}},"required":["successStatus"],"additionalProperties":false}}}},"responses":{"200":{"description":"Closed opportunity detail, or dryRun returned write readiness.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["opportunity"]},"id":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["user"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["system"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string","enum":["System User"]}},"required":["type","id","displayName"],"additionalProperties":false}]},"updatedAt":{"type":"string","format":"date-time"},"closedAt":{"type":["string","null"],"format":"date-time"},"title":{"type":"string"},"description":{"type":"string"},"status":{"type":"string","enum":["LEAD","IN_PROGRESS","CLOSED"]},"successStatus":{"type":["string","null"],"enum":["WON","LOST"]},"estimatedValue":{"type":["object","null"],"properties":{"value":{"type":"string","pattern":"^\\d+(?:\\.\\d{2})$"},"kind":{"type":"string","enum":["estimate"]},"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"}},"required":["value","kind","currencyCode"],"additionalProperties":false},"source":{"type":"string","enum":["UI","PUBLIC_API","TRANSCRIPT","IMPORT"]},"assignedTo":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false},"relationships":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"customer":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"pipelineStatus":{"type":"string"}},"required":["id","name","pipelineStatus"],"additionalProperties":false}},"required":["customer"],"additionalProperties":false},{"type":"object","properties":{"supplier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false}},"required":["supplier"],"additionalProperties":false}]}},"products":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"code":{"type":"string"}},"required":["id","code"],"additionalProperties":false}},"createdVia":{"type":["object","null"],"properties":{"type":{"type":"string","enum":["public_api"]},"actorUserId":{"type":"string","format":"uuid"}},"required":["type","actorUserId"],"additionalProperties":false},"requestedVia":{"type":"object","properties":{"type":{"type":"string","enum":["api_key"]},"id":{"type":"string","format":"uuid"},"purpose":{"type":["string","null"]}},"required":["type","id","purpose"],"additionalProperties":false},"closingNotes":{"type":["string","null"]},"sourceDetail":{"type":["string","null"]},"meta":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"}},"required":["key","value","updatedAt"],"additionalProperties":false}},"timeline":{"type":"array","items":{"type":"object","properties":{"eventType":{"type":"string"},"createdAt":{"type":"string","format":"date-time"}},"required":["eventType","createdAt"],"additionalProperties":false},"maxItems":100},"timelineCoverage":{"type":"object","properties":{"status":{"type":"string","enum":["complete","bounded"]},"limit":{"type":"number","enum":[100]}},"required":["status","limit"],"additionalProperties":false},"statusIntegrity":{"type":"string","enum":["valid","legacy_closed_without_outcome"]},"idempotencyStatus":{"type":"string","enum":["created","replayed","updated","closed","meta_updated","fetched"]}},"required":["type","id","createdAt","createdBy","updatedAt","closedAt","title","description","status","successStatus","estimatedValue","source","assignedTo","relationships","products","createdVia","requestedVia","closingNotes","sourceDetail","meta","timeline","timelineCoverage","statusIntegrity","idempotencyStatus"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["write_readiness"]},"operation":{"type":"string","enum":["warehouses.create","warehouses.update","warehouses.archive","warehouses.unarchive","shipping_options.create","shipping_options.update","shipping_options.archive","shipping_options.unarchive","reorder_points.create","tags.create","tags.update","tag_assignments.create","tag_assignments.delete","notes.create","notes.update","opportunities.create","opportunities.update","opportunities.close","opportunities.meta-upsert","contacts.create","contacts.update","customers.create","customers.update","customer_locations.create","customer_locations.update","customer_addresses.create","customer_addresses.update","suppliers.create","suppliers.update","supplier_ship_from_locations.create","supplier_ship_from_locations.update","products.create","products.update","products.archive","products.unarchive","product_packaging.create","products.suppliers.create","products.suppliers.delete","products.aliases.create","products.aliases.update","products.aliases.delete","product_families.aliases.create","product_families.aliases.update","product_families.aliases.delete","products.customer_part_numbers.create","products.customer_part_numbers.update","products.customer_part_numbers.delete","product_sds.update","product_documents.create","customer_documents.create","supplier_documents.create","purchase_order_documents.create","product_families.create","product_families.update","cost_book_entries.create","current_cost_sources.put","customers.archive","customers.unarchive","suppliers.archive","suppliers.unarchive","contacts.archive","contacts.unarchive","customer_addresses.archive","customer_addresses.unarchive","supplier_ship_from_locations.archive","supplier_ship_from_locations.unarchive","representatives.create","representatives.update","representatives.archive","representatives.unarchive","payment_terms.create","payment_terms.update","ledger_accounts.create","ledger_accounts.update"]},"status":{"type":"string","enum":["ready","blocked"]},"wouldWrite":{"type":"boolean","enum":[false]},"submit":{"type":"object","properties":{"method":{"type":"string","enum":["POST","PATCH","PUT","DELETE"]},"path":{"type":"string"},"query":{"type":"object","properties":{},"additionalProperties":false}},"required":["method","path","query"],"additionalProperties":false},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false},"checks":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["not_direct_ship","address_role_required","address_role_valid","already_assigned","already_exists","active_duplicate","ambiguous_external_id","ambiguous_natural_key","api_created","archived_target","archived_record","archive_blocked","account_type_locked","duplicate_candidate_found","duplicate_candidate_overflow","duplicate_check_clear","duplicate_check_not_needed","duplicate_contact","duplicate_customer","duplicate_customer_address","duplicate_customer_location","duplicate_note","duplicate_resolution_applied","duplicate_supplier","duplicate_supplier_ship_from_location","document_url_org_scoped","document_url_valid","upload_verified","sds_converged","idempotency_available","idempotency_key_required","idempotency_key_reused","idempotency_replay","idempotency_target_missing","income_statement_type_invalid","hard_identity_clear","nested_external_id_clear","commercial_references_valid","credit_denomination_mismatch","customer_service_representative_reference_active","ledger_account_reference_valid","payment_terms_reference_exists","sales_person_reference_active","supplier_representative_reference_active","duplicate_reference_identity","external_id_conflict","if_match_current","base_uom_transition_allowed","base_uom_transition_blocked","attribute_assignments_valid","attribute_assignments_invalid","selected_supplier_link","linked_records_available","natural_key_conflict","not_api_created","no_downstream_mutation","order_sensitive_update_allowed","order_sensitive_update_blocked","parent_available","cost_book_entry_blocked","cost_book_entry_valid","cost_book_reference_not_visible","unsupported_cost_book_uom","cost_uom_conversion_unavailable","cost_book_base_unavailable","cost_book_base_ambiguous","cost_ship_from_location_not_visible","cost_package_quantity_invalid","cost_component_invalid","cost_date_window_invalid","cost_date_overlap","cost_amount_overflow","cost_book_conflict","product_family_reference_active","product_packaging_reference_active","primary_child_available","primary_change_unsupported","reference_visibility_blocked","scope_authorized","stale_record","stale_cost_book_entry","supplier_reference_active","tag_applicable","tag_available","tag_exists","tag_found","tag_not_applicable","tag_not_found","type_immutable","type_known","type_required","target_active","target_available","target_not_found_or_not_visible","targets_visible","unsupported_linked_record","unsupported_profile_shape","variable_qty_valid","validation_failed","value_nonempty"]},"status":{"type":"string","enum":["passed","blocked"]},"message":{"type":"string"},"param":{"type":"string"}},"required":["code","status","message"],"additionalProperties":false}},"duplicateCandidates":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact","customer","supplier","customer_location","customer_address","supplier_ship_from_location","product","product_family","document"]},"readable":{"type":"boolean"},"version":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","product","purchase_order"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"matchReasons":{"type":"array","items":{"type":"string","enum":["name","email","externalId","address","code","product","url"]}},"readbackPath":{"type":"string"}},"required":["type","readable","matchReasons"],"additionalProperties":false}},"idempotency":{"type":"object","properties":{"required":{"type":"boolean"},"keyProvided":{"type":"boolean"},"wouldReplay":{"type":"boolean"}},"required":["required","keyProvided","wouldReplay"],"additionalProperties":false},"wouldChange":{"type":"object","properties":{"fieldNames":{"type":"array","items":{"type":"string"}},"values":{"type":"object","additionalProperties":{}}},"required":["fieldNames","values"],"additionalProperties":false},"impactAnalysis":{"type":"object","additionalProperties":{}},"requestId":{"type":"string"}},"required":["type","operation","status","wouldWrite","submit","verification","checks","duplicateCandidates","requestId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}]}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested parent or record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"409":{"description":"The write conflicted with an existing record, idempotency payload, or stale If-Match value.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/opportunities/{id}/meta":{"put":{"operationId":"upsertPublicAPIOpportunityMeta","summary":"Upsert opportunity metadata","description":"Creates or replaces one opportunity metadata value by key. The target must be visible under the same deny-by-default aspect authority. dryRun=true reports target visibility and write readiness.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"opportunities:write","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","enum":["true"]},"required":false,"name":"dryRun","in":"query"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":120},"value":{"type":"string","minLength":1,"maxLength":4000}},"required":["key","value"],"additionalProperties":false}}}},"responses":{"200":{"description":"Opportunity detail after metadata upsert, or dryRun readiness.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["opportunity"]},"id":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["user"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["system"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string","enum":["System User"]}},"required":["type","id","displayName"],"additionalProperties":false}]},"updatedAt":{"type":"string","format":"date-time"},"closedAt":{"type":["string","null"],"format":"date-time"},"title":{"type":"string"},"description":{"type":"string"},"status":{"type":"string","enum":["LEAD","IN_PROGRESS","CLOSED"]},"successStatus":{"type":["string","null"],"enum":["WON","LOST"]},"estimatedValue":{"type":["object","null"],"properties":{"value":{"type":"string","pattern":"^\\d+(?:\\.\\d{2})$"},"kind":{"type":"string","enum":["estimate"]},"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"}},"required":["value","kind","currencyCode"],"additionalProperties":false},"source":{"type":"string","enum":["UI","PUBLIC_API","TRANSCRIPT","IMPORT"]},"assignedTo":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false},"relationships":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"customer":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"pipelineStatus":{"type":"string"}},"required":["id","name","pipelineStatus"],"additionalProperties":false}},"required":["customer"],"additionalProperties":false},{"type":"object","properties":{"supplier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false}},"required":["supplier"],"additionalProperties":false}]}},"products":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"code":{"type":"string"}},"required":["id","code"],"additionalProperties":false}},"createdVia":{"type":["object","null"],"properties":{"type":{"type":"string","enum":["public_api"]},"actorUserId":{"type":"string","format":"uuid"}},"required":["type","actorUserId"],"additionalProperties":false},"requestedVia":{"type":"object","properties":{"type":{"type":"string","enum":["api_key"]},"id":{"type":"string","format":"uuid"},"purpose":{"type":["string","null"]}},"required":["type","id","purpose"],"additionalProperties":false},"closingNotes":{"type":["string","null"]},"sourceDetail":{"type":["string","null"]},"meta":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"}},"required":["key","value","updatedAt"],"additionalProperties":false}},"timeline":{"type":"array","items":{"type":"object","properties":{"eventType":{"type":"string"},"createdAt":{"type":"string","format":"date-time"}},"required":["eventType","createdAt"],"additionalProperties":false},"maxItems":100},"timelineCoverage":{"type":"object","properties":{"status":{"type":"string","enum":["complete","bounded"]},"limit":{"type":"number","enum":[100]}},"required":["status","limit"],"additionalProperties":false},"statusIntegrity":{"type":"string","enum":["valid","legacy_closed_without_outcome"]},"idempotencyStatus":{"type":"string","enum":["created","replayed","updated","closed","meta_updated","fetched"]}},"required":["type","id","createdAt","createdBy","updatedAt","closedAt","title","description","status","successStatus","estimatedValue","source","assignedTo","relationships","products","createdVia","requestedVia","closingNotes","sourceDetail","meta","timeline","timelineCoverage","statusIntegrity","idempotencyStatus"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["write_readiness"]},"operation":{"type":"string","enum":["warehouses.create","warehouses.update","warehouses.archive","warehouses.unarchive","shipping_options.create","shipping_options.update","shipping_options.archive","shipping_options.unarchive","reorder_points.create","tags.create","tags.update","tag_assignments.create","tag_assignments.delete","notes.create","notes.update","opportunities.create","opportunities.update","opportunities.close","opportunities.meta-upsert","contacts.create","contacts.update","customers.create","customers.update","customer_locations.create","customer_locations.update","customer_addresses.create","customer_addresses.update","suppliers.create","suppliers.update","supplier_ship_from_locations.create","supplier_ship_from_locations.update","products.create","products.update","products.archive","products.unarchive","product_packaging.create","products.suppliers.create","products.suppliers.delete","products.aliases.create","products.aliases.update","products.aliases.delete","product_families.aliases.create","product_families.aliases.update","product_families.aliases.delete","products.customer_part_numbers.create","products.customer_part_numbers.update","products.customer_part_numbers.delete","product_sds.update","product_documents.create","customer_documents.create","supplier_documents.create","purchase_order_documents.create","product_families.create","product_families.update","cost_book_entries.create","current_cost_sources.put","customers.archive","customers.unarchive","suppliers.archive","suppliers.unarchive","contacts.archive","contacts.unarchive","customer_addresses.archive","customer_addresses.unarchive","supplier_ship_from_locations.archive","supplier_ship_from_locations.unarchive","representatives.create","representatives.update","representatives.archive","representatives.unarchive","payment_terms.create","payment_terms.update","ledger_accounts.create","ledger_accounts.update"]},"status":{"type":"string","enum":["ready","blocked"]},"wouldWrite":{"type":"boolean","enum":[false]},"submit":{"type":"object","properties":{"method":{"type":"string","enum":["POST","PATCH","PUT","DELETE"]},"path":{"type":"string"},"query":{"type":"object","properties":{},"additionalProperties":false}},"required":["method","path","query"],"additionalProperties":false},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false},"checks":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["not_direct_ship","address_role_required","address_role_valid","already_assigned","already_exists","active_duplicate","ambiguous_external_id","ambiguous_natural_key","api_created","archived_target","archived_record","archive_blocked","account_type_locked","duplicate_candidate_found","duplicate_candidate_overflow","duplicate_check_clear","duplicate_check_not_needed","duplicate_contact","duplicate_customer","duplicate_customer_address","duplicate_customer_location","duplicate_note","duplicate_resolution_applied","duplicate_supplier","duplicate_supplier_ship_from_location","document_url_org_scoped","document_url_valid","upload_verified","sds_converged","idempotency_available","idempotency_key_required","idempotency_key_reused","idempotency_replay","idempotency_target_missing","income_statement_type_invalid","hard_identity_clear","nested_external_id_clear","commercial_references_valid","credit_denomination_mismatch","customer_service_representative_reference_active","ledger_account_reference_valid","payment_terms_reference_exists","sales_person_reference_active","supplier_representative_reference_active","duplicate_reference_identity","external_id_conflict","if_match_current","base_uom_transition_allowed","base_uom_transition_blocked","attribute_assignments_valid","attribute_assignments_invalid","selected_supplier_link","linked_records_available","natural_key_conflict","not_api_created","no_downstream_mutation","order_sensitive_update_allowed","order_sensitive_update_blocked","parent_available","cost_book_entry_blocked","cost_book_entry_valid","cost_book_reference_not_visible","unsupported_cost_book_uom","cost_uom_conversion_unavailable","cost_book_base_unavailable","cost_book_base_ambiguous","cost_ship_from_location_not_visible","cost_package_quantity_invalid","cost_component_invalid","cost_date_window_invalid","cost_date_overlap","cost_amount_overflow","cost_book_conflict","product_family_reference_active","product_packaging_reference_active","primary_child_available","primary_change_unsupported","reference_visibility_blocked","scope_authorized","stale_record","stale_cost_book_entry","supplier_reference_active","tag_applicable","tag_available","tag_exists","tag_found","tag_not_applicable","tag_not_found","type_immutable","type_known","type_required","target_active","target_available","target_not_found_or_not_visible","targets_visible","unsupported_linked_record","unsupported_profile_shape","variable_qty_valid","validation_failed","value_nonempty"]},"status":{"type":"string","enum":["passed","blocked"]},"message":{"type":"string"},"param":{"type":"string"}},"required":["code","status","message"],"additionalProperties":false}},"duplicateCandidates":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact","customer","supplier","customer_location","customer_address","supplier_ship_from_location","product","product_family","document"]},"readable":{"type":"boolean"},"version":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","product","purchase_order"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"matchReasons":{"type":"array","items":{"type":"string","enum":["name","email","externalId","address","code","product","url"]}},"readbackPath":{"type":"string"}},"required":["type","readable","matchReasons"],"additionalProperties":false}},"idempotency":{"type":"object","properties":{"required":{"type":"boolean"},"keyProvided":{"type":"boolean"},"wouldReplay":{"type":"boolean"}},"required":["required","keyProvided","wouldReplay"],"additionalProperties":false},"wouldChange":{"type":"object","properties":{"fieldNames":{"type":"array","items":{"type":"string"}},"values":{"type":"object","additionalProperties":{}}},"required":["fieldNames","values"],"additionalProperties":false},"impactAnalysis":{"type":"object","additionalProperties":{}},"requestId":{"type":"string"}},"required":["type","operation","status","wouldWrite","submit","verification","checks","duplicateCandidates","requestId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}]}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested parent or record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"409":{"description":"The write conflicted with an existing record, idempotency payload, or stale If-Match value.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/note-activity":{"get":{"operationId":"findPublicAPINoteActivity","summary":"Count or list CRM note activity","description":"Returns exact organization-wide CRM note counts grouped by one dimension or a newest-first excerpt list. Calendar windows use the organization timezone and may span up to 50 years, or at most 366 days when a contains filter is applied. List continuations use an opaque signed cursor that must be sent without any other query parameter. Access requires notes:read as an additional credential gate plus live Notes read authority. That authority is broad note.view, or the complete scoped Notes bundle of note.view:salesperson together with a customer read lane and an order read lane. Incomplete custom roles are denied. Organization-wide results do not require a subject filter; a supplied subject filter must independently be readable.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"notes:read","parameters":[{"schema":{"type":"string"},"required":false,"name":"view","in":"query"},{"schema":{"type":"string"},"required":false,"name":"groupBy","in":"query"},{"schema":{"type":"string"},"required":false,"name":"happenedAtFrom","in":"query"},{"schema":{"type":"string"},"required":false,"name":"happenedAtTo","in":"query"},{"schema":{"type":"string"},"required":false,"name":"noteType","in":"query"},{"schema":{"type":"string"},"required":false,"name":"createdById","in":"query"},{"schema":{"type":"string"},"required":false,"name":"subjectType","in":"query"},{"schema":{"type":"string"},"required":false,"name":"subjectId","in":"query"},{"schema":{"type":"string"},"required":false,"name":"contains","in":"query"},{"schema":{"type":"string","pattern":"^\\d+$"},"required":false,"name":"limit","in":"query"},{"schema":{"type":"string"},"required":false,"name":"cursor","in":"query"}],"responses":{"200":{"description":"Note activity rows with exact population and continuation metadata.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"dimensionKey":{"type":"string"},"dimensionLabel":{"type":"string"},"noteCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"dimensionType":{"type":["string","null"],"enum":["BILL","BILL_CREDIT_NOTE","BULK_PAYMENT","CERT","CONTACT","COST_DERIVATION","CREDIT_NOTE","CUSTOMER","CUSTOMER_NOTE","CUSTOMER_PAYMENT","DEPOSIT","INVOICE","LEDGER_TRANSACTION","OPPORTUNITY","ORDER","PRODUCT","PRODUCT_FAMILY","PURCHASE_ORDER","RELATIONSHIP","SHIP_FROM_ADDRESS","SHIP_TO_ADDRESS","SUPPLIER","SUPPLIER_COST","SUPPLIER_PAYMENT","USER","WAREHOUSE","WORK_ORDER"]},"dimensionId":{"type":["string","null"],"format":"uuid"}},"required":["dimensionKey","dimensionLabel","noteCount"],"additionalProperties":false}},"meta":{"type":"object","properties":{"windowFrom":{"type":"string","format":"date-time"},"windowTo":{"type":"string","format":"date-time"},"timezone":{"type":"string"},"totalNotes":{"type":"integer","minimum":0},"limit":{"type":"integer","exclusiveMinimum":0},"hasMore":{"type":"boolean"},"nextCursor":{"type":["string","null"]},"warnings":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"generatedAt":{"type":"string","format":"date-time"},"view":{"type":"string","enum":["activity"]},"groupBy":{"type":"string","enum":["day","noteType","author","subject"]}},"required":["windowFrom","windowTo","timezone","totalNotes","limit","hasMore","nextCursor","warnings","generatedAt","view","groupBy"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"happenedDay":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"createdAt":{"type":"string","format":"date-time"},"noteType":{"type":"string","enum":["PHONE_MEETING","PHYSICAL_MEETING","VIRTUAL_MEETING","NOTE","EMAIL","SAMPLE_REQUEST","OPPORTUNITY","QUOTE"]},"title":{"type":"string"},"author":{"type":"string"},"subjectType":{"type":["string","null"],"enum":["BILL","BILL_CREDIT_NOTE","BULK_PAYMENT","CERT","CONTACT","COST_DERIVATION","CREDIT_NOTE","CUSTOMER","CUSTOMER_NOTE","CUSTOMER_PAYMENT","DEPOSIT","INVOICE","LEDGER_TRANSACTION","OPPORTUNITY","ORDER","PRODUCT","PRODUCT_FAMILY","PURCHASE_ORDER","RELATIONSHIP","SHIP_FROM_ADDRESS","SHIP_TO_ADDRESS","SUPPLIER","SUPPLIER_COST","SUPPLIER_PAYMENT","USER","WAREHOUSE","WORK_ORDER"]},"subjectId":{"type":["string","null"],"format":"uuid"},"subjectName":{"type":"string"},"excerpt":{"type":"string","maxLength":240}},"required":["id","happenedDay","createdAt","noteType","title","author","subjectType","subjectId","subjectName","excerpt"],"additionalProperties":false}},"meta":{"type":"object","properties":{"windowFrom":{"type":"string","format":"date-time"},"windowTo":{"type":"string","format":"date-time"},"timezone":{"type":"string"},"totalNotes":{"type":"integer","minimum":0},"limit":{"type":"integer","exclusiveMinimum":0},"hasMore":{"type":"boolean"},"nextCursor":{"type":["string","null"]},"warnings":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"generatedAt":{"type":"string","format":"date-time"},"view":{"type":"string","enum":["list"]},"groupBy":{"type":"null"}},"required":["windowFrom","windowTo","timezone","totalNotes","limit","hasMore","nextCursor","warnings","generatedAt","view","groupBy"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}]}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/email-activity":{"get":{"operationId":"findPublicAPIEmailActivity","summary":"Count or list emails ShelfCycle sent","description":"Counts emails ShelfCycle sent and email notes the actor can open, lists them, or lists customers with no email in the window. Requires sent-emails:read plus the read scope for each record kind. Notes require notes:read. Sent means handed to the mail provider.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"sent-emails:read","parameters":[{"schema":{"type":"string"},"required":false,"name":"view","in":"query"},{"schema":{"type":"string"},"required":false,"name":"groupBy","in":"query"},{"schema":{"type":"string"},"required":false,"name":"from","in":"query"},{"schema":{"type":"string"},"required":false,"name":"to","in":"query"},{"schema":{"type":"array","items":{"type":"string","enum":["INVOICE","SALES_ORDER","PURCHASE_ORDER","SUPPLIER_PAYMENT","CREDIT_NOTE","PRICE_LETTER","AR_STATEMENT"]},"minItems":1,"maxItems":7},"required":false,"name":"sentKind","in":"query"},{"schema":{"type":"array","items":{"type":"string","enum":["PHONE_MEETING","PHYSICAL_MEETING","VIRTUAL_MEETING","NOTE","EMAIL","SAMPLE_REQUEST","OPPORTUNITY","QUOTE"]},"maxItems":8},"required":false,"name":"noteType","in":"query"},{"schema":{"type":"string"},"required":false,"name":"senderId","in":"query"},{"schema":{"type":"string"},"required":false,"name":"subjectType","in":"query"},{"schema":{"type":"string"},"required":false,"name":"subjectId","in":"query"},{"schema":{"type":"string"},"required":false,"name":"salesPersonId","in":"query"},{"schema":{"type":"string"},"required":false,"name":"salesOwnership","in":"query"},{"schema":{"type":"string"},"required":false,"name":"limit","in":"query"}],"responses":{"200":{"description":"Email activity for the requested view.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"view":{"type":"string","enum":["activity"]},"groupBy":{"type":"string","enum":["day","kind","sender","subject"]},"timezone":{"type":"string"},"from":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"to":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"windowFrom":{"type":"string","format":"date-time"},"windowTo":{"type":"string","format":"date-time"},"coverage":{"type":"object","properties":{"truncated":{"type":"boolean"},"rowScope":{"type":"string","enum":["organization","assigned_salesperson"]},"negativeClosureEligible":{"type":"boolean"},"actorNotSalesperson":{"type":"boolean"}},"required":["truncated","rowScope","negativeClosureEligible","actorNotSalesperson"],"additionalProperties":false},"disclosure":{"type":"object","properties":{"sourcesSearched":{"type":"array","items":{"type":"string"}},"kindsNotSearched":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"reason":{"type":"string","enum":["permission","scope","unreadable"]}},"required":["label","reason"],"additionalProperties":false}},"notesUnavailable":{"type":"boolean"},"notesEmptiedByFilter":{"type":"boolean"},"notSearched":{"type":"array","items":{"type":"string"}},"deletedRecordEmailsExcluded":{"type":"boolean","enum":[true]},"unlinkedEmailCount":{"type":"integer","minimum":0},"unlinkedEmailNoteCount":{"type":["integer","null"],"minimum":0},"emailNotesDatedWhenForwarded":{"type":"boolean"},"sentMeans":{"type":"string"},"prospectsIncluded":{"type":"boolean"},"closure":{"type":"string","enum":["none","none_on_records_you_can_open"]}},"required":["sourcesSearched","kindsNotSearched","notesUnavailable","notesEmptiedByFilter","notSearched","deletedRecordEmailsExcluded","unlinkedEmailCount","unlinkedEmailNoteCount","emailNotesDatedWhenForwarded","sentMeans","prospectsIncluded","closure"],"additionalProperties":false},"totalSent":{"type":"integer","minimum":0},"totalNotes":{"type":"integer","minimum":0},"rows":{"type":"array","items":{"type":"object","properties":{"dimensionKey":{"type":"string"},"dimensionLabel":{"type":"string"},"sentCount":{"type":"integer","minimum":0},"noteCount":{"type":"integer","minimum":0},"subjectType":{"type":["string","null"],"enum":["customer","supplier"]},"subjectId":{"type":["string","null"],"format":"uuid"}},"required":["dimensionKey","dimensionLabel","sentCount","noteCount","subjectType","subjectId"],"additionalProperties":false}}},"required":["view","groupBy","timezone","from","to","windowFrom","windowTo","coverage","disclosure","totalSent","totalNotes","rows"],"additionalProperties":false},{"type":"object","properties":{"view":{"type":"string","enum":["list"]},"timezone":{"type":"string"},"from":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"to":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"windowFrom":{"type":"string","format":"date-time"},"windowTo":{"type":"string","format":"date-time"},"coverage":{"type":"object","properties":{"truncated":{"type":"boolean"},"rowScope":{"type":"string","enum":["organization","assigned_salesperson"]},"negativeClosureEligible":{"type":"boolean"},"actorNotSalesperson":{"type":"boolean"}},"required":["truncated","rowScope","negativeClosureEligible","actorNotSalesperson"],"additionalProperties":false},"disclosure":{"type":"object","properties":{"sourcesSearched":{"type":"array","items":{"type":"string"}},"kindsNotSearched":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"reason":{"type":"string","enum":["permission","scope","unreadable"]}},"required":["label","reason"],"additionalProperties":false}},"notesUnavailable":{"type":"boolean"},"notesEmptiedByFilter":{"type":"boolean"},"notSearched":{"type":"array","items":{"type":"string"}},"deletedRecordEmailsExcluded":{"type":"boolean","enum":[true]},"unlinkedEmailCount":{"type":"integer","minimum":0},"unlinkedEmailNoteCount":{"type":["integer","null"],"minimum":0},"emailNotesDatedWhenForwarded":{"type":"boolean"},"sentMeans":{"type":"string"},"prospectsIncluded":{"type":"boolean"},"closure":{"type":"string","enum":["none","none_on_records_you_can_open"]}},"required":["sourcesSearched","kindsNotSearched","notesUnavailable","notesEmptiedByFilter","notSearched","deletedRecordEmailsExcluded","unlinkedEmailCount","unlinkedEmailNoteCount","emailNotesDatedWhenForwarded","sentMeans","prospectsIncluded","closure"],"additionalProperties":false},"totalSent":{"type":"integer","minimum":0},"totalNotes":{"type":"integer","minimum":0},"totalsByKind":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"count":{"type":"integer","minimum":0}},"required":["label","count"],"additionalProperties":false}},"rows":{"type":"array","items":{"type":"object","properties":{"source":{"type":"string","enum":["sent","note"]},"kindLabel":{"type":"string"},"at":{"type":"string","format":"date-time"},"senderName":{"type":"string"},"subjectType":{"type":["string","null"],"enum":["customer","supplier"]},"subjectId":{"type":["string","null"],"format":"uuid"},"subjectName":{"type":["string","null"]},"title":{"type":"string"},"linkedKind":{"type":["string","null"]},"linkedId":{"type":["string","null"],"format":"uuid"},"emailId":{"type":["string","null"],"format":"uuid"},"noteId":{"type":["string","null"],"format":"uuid"}},"required":["source","kindLabel","at","senderName","subjectType","subjectId","subjectName","title","linkedKind","linkedId","emailId","noteId"],"additionalProperties":false}}},"required":["view","timezone","from","to","windowFrom","windowTo","coverage","disclosure","totalSent","totalNotes","totalsByKind","rows"],"additionalProperties":false},{"type":"object","properties":{"view":{"type":"string","enum":["customers"]},"timezone":{"type":"string"},"from":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"to":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"windowFrom":{"type":"string","format":"date-time"},"windowTo":{"type":"string","format":"date-time"},"coverage":{"type":"object","properties":{"truncated":{"type":"boolean"},"rowScope":{"type":"string","enum":["organization","assigned_salesperson"]},"negativeClosureEligible":{"type":"boolean"},"actorNotSalesperson":{"type":"boolean"}},"required":["truncated","rowScope","negativeClosureEligible","actorNotSalesperson"],"additionalProperties":false},"disclosure":{"type":"object","properties":{"sourcesSearched":{"type":"array","items":{"type":"string"}},"kindsNotSearched":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"reason":{"type":"string","enum":["permission","scope","unreadable"]}},"required":["label","reason"],"additionalProperties":false}},"notesUnavailable":{"type":"boolean"},"notesEmptiedByFilter":{"type":"boolean"},"notSearched":{"type":"array","items":{"type":"string"}},"deletedRecordEmailsExcluded":{"type":"boolean","enum":[true]},"unlinkedEmailCount":{"type":"integer","minimum":0},"unlinkedEmailNoteCount":{"type":["integer","null"],"minimum":0},"emailNotesDatedWhenForwarded":{"type":"boolean"},"sentMeans":{"type":"string"},"prospectsIncluded":{"type":"boolean"},"closure":{"type":"string","enum":["none","none_on_records_you_can_open"]}},"required":["sourcesSearched","kindsNotSearched","notesUnavailable","notesEmptiedByFilter","notSearched","deletedRecordEmailsExcluded","unlinkedEmailCount","unlinkedEmailNoteCount","emailNotesDatedWhenForwarded","sentMeans","prospectsIncluded","closure"],"additionalProperties":false},"baseCount":{"type":"integer","minimum":0},"emailedCount":{"type":"integer","minimum":0},"notEmailedCount":{"type":"integer","minimum":0},"shelfCycleEmailOnlyCount":{"type":"integer","minimum":0},"noteOnlyCount":{"type":"integer","minimum":0},"bothCount":{"type":"integer","minimum":0},"neitherCount":{"type":"integer","minimum":0},"rows":{"type":"array","items":{"type":"object","properties":{"customerId":{"type":"string","format":"uuid"},"customerName":{"type":"string"},"hasOtherNote":{"type":"boolean"}},"required":["customerId","customerName","hasOtherNote"],"additionalProperties":false}}},"required":["view","timezone","from","to","windowFrom","windowTo","coverage","disclosure","baseCount","emailedCount","notEmailedCount","shelfCycleEmailOnlyCount","noteOnlyCount","bothCount","neitherCount","rows"],"additionalProperties":false}]}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/sent-emails/{id}":{"get":{"operationId":"getPublicAPISentEmail","summary":"Read one email ShelfCycle sent","description":"Returns one sent email the actor can open. File rows are 900-second signed links and contain no extracted text. Requires sent-emails:read plus the read scope for that email's record kind.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"sent-emails:read","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"One sent email.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"emailId":{"type":"string","format":"uuid"},"kindLabel":{"type":"string"},"sentAt":{"type":"string","format":"date-time"},"senderName":{"type":"string"},"to":{"type":"array","items":{"type":"string"}},"cc":{"type":"array","items":{"type":"string"}},"bcc":{"type":"array","items":{"type":"string"}},"subject":{"type":"string"},"message":{"type":"string"},"linkedKind":{"type":["string","null"]},"linkedId":{"type":["string","null"],"format":"uuid"},"linkedLabel":{"type":["string","null"]},"files":{"type":"array","items":{"type":"object","properties":{"fileName":{"type":"string"},"kept":{"type":"boolean"},"href":{"type":["string","null"]}},"required":["fileName","kept","href"],"additionalProperties":false}},"priceLetterFact":{"type":["string","null"]},"sentMeans":{"type":"string"}},"required":["emailId","kindLabel","sentAt","senderName","to","cc","bcc","subject","message","linkedKind","linkedId","linkedLabel","files","priceLetterFact","sentMeans"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/notes/{id}":{"get":{"operationId":"getPublicAPINote","summary":"Get a public API note","description":"Returns a visible CRM note with body. notes:read can read visible human or API notes; notes:write can read API-created notes for v1 compatibility.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":["notes:read","notes:write"],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Note detail.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["note"]},"url":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"object","properties":{"type":{"type":"string","enum":["user"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"createdVia":{"type":["object","null"],"properties":{"type":{"type":"string","enum":["public_api"]},"actorUserId":{"type":"string","format":"uuid"}},"required":["type","actorUserId"],"additionalProperties":false},"requestedVia":{"type":"object","properties":{"type":{"type":"string","enum":["api_key"]},"id":{"type":"string","format":"uuid"},"purpose":{"type":["string","null"]}},"required":["type","id","purpose"],"additionalProperties":false},"noteType":{"type":"string","enum":["PHONE_MEETING","PHYSICAL_MEETING","VIRTUAL_MEETING","NOTE","EMAIL","SAMPLE_REQUEST","OPPORTUNITY","QUOTE"]},"title":{"type":"string"},"body":{"type":"string"},"happenedAt":{"type":"string","format":"date-time"},"primarySubject":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["customer"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["supplier"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["product"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["redacted"]},"recordType":{"type":"string","enum":["customer","supplier","product"]}},"required":["type","recordType"],"additionalProperties":false}]},"linkedRecords":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["customer"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["supplier"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["product"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["contact"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["location"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["user"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["redacted"]},"recordType":{"type":"string","enum":["customer","supplier","product","contact","location"]}},"required":["type","recordType"],"additionalProperties":false}]}},"externalId":{"type":["string","null"]},"idempotencyStatus":{"type":"string","enum":["created","replayed","updated","fetched"]}},"required":["id","type","url","createdAt","updatedAt","createdBy","createdVia","requestedVia","noteType","title","body","happenedAt","primarySubject","linkedRecords","externalId","idempotencyStatus"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updatePublicAPINote","summary":"Update a public API note","description":"Updates a note created through the public API. Execute requests require If-Match. dryRun=true may omit If-Match and returns a blocked readiness check instead of writing.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"notes:write","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","enum":["true"]},"required":false,"name":"dryRun","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check."},"required":false,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check.","name":"If-Match","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"linkedRecords":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","product","contact","location","user"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},"maxItems":50},"noteType":{"type":"string","enum":["PHONE_MEETING","PHYSICAL_MEETING","VIRTUAL_MEETING","NOTE","EMAIL","SAMPLE_REQUEST","OPPORTUNITY","QUOTE"]},"title":{"type":"string","minLength":1,"maxLength":240},"body":{"type":"string","minLength":1,"maxLength":20000},"happenedAt":{"type":"string","format":"date-time"},"externalId":{"type":["string","null"],"maxLength":120}},"additionalProperties":false}}}},"responses":{"200":{"description":"Updated note detail, or dryRun returned write readiness.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["note"]},"url":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"object","properties":{"type":{"type":"string","enum":["user"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"createdVia":{"type":["object","null"],"properties":{"type":{"type":"string","enum":["public_api"]},"actorUserId":{"type":"string","format":"uuid"}},"required":["type","actorUserId"],"additionalProperties":false},"requestedVia":{"type":"object","properties":{"type":{"type":"string","enum":["api_key"]},"id":{"type":"string","format":"uuid"},"purpose":{"type":["string","null"]}},"required":["type","id","purpose"],"additionalProperties":false},"noteType":{"type":"string","enum":["PHONE_MEETING","PHYSICAL_MEETING","VIRTUAL_MEETING","NOTE","EMAIL","SAMPLE_REQUEST","OPPORTUNITY","QUOTE"]},"title":{"type":"string"},"body":{"type":"string"},"happenedAt":{"type":"string","format":"date-time"},"primarySubject":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["customer"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["supplier"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["product"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["redacted"]},"recordType":{"type":"string","enum":["customer","supplier","product"]}},"required":["type","recordType"],"additionalProperties":false}]},"linkedRecords":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["customer"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["supplier"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["product"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["contact"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["location"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["user"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["redacted"]},"recordType":{"type":"string","enum":["customer","supplier","product","contact","location"]}},"required":["type","recordType"],"additionalProperties":false}]}},"externalId":{"type":["string","null"]},"idempotencyStatus":{"type":"string","enum":["created","replayed","updated","fetched"]}},"required":["id","type","url","createdAt","updatedAt","createdBy","createdVia","requestedVia","noteType","title","body","happenedAt","primarySubject","linkedRecords","externalId","idempotencyStatus"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["write_readiness"]},"operation":{"type":"string","enum":["warehouses.create","warehouses.update","warehouses.archive","warehouses.unarchive","shipping_options.create","shipping_options.update","shipping_options.archive","shipping_options.unarchive","reorder_points.create","tags.create","tags.update","tag_assignments.create","tag_assignments.delete","notes.create","notes.update","opportunities.create","opportunities.update","opportunities.close","opportunities.meta-upsert","contacts.create","contacts.update","customers.create","customers.update","customer_locations.create","customer_locations.update","customer_addresses.create","customer_addresses.update","suppliers.create","suppliers.update","supplier_ship_from_locations.create","supplier_ship_from_locations.update","products.create","products.update","products.archive","products.unarchive","product_packaging.create","products.suppliers.create","products.suppliers.delete","products.aliases.create","products.aliases.update","products.aliases.delete","product_families.aliases.create","product_families.aliases.update","product_families.aliases.delete","products.customer_part_numbers.create","products.customer_part_numbers.update","products.customer_part_numbers.delete","product_sds.update","product_documents.create","customer_documents.create","supplier_documents.create","purchase_order_documents.create","product_families.create","product_families.update","cost_book_entries.create","current_cost_sources.put","customers.archive","customers.unarchive","suppliers.archive","suppliers.unarchive","contacts.archive","contacts.unarchive","customer_addresses.archive","customer_addresses.unarchive","supplier_ship_from_locations.archive","supplier_ship_from_locations.unarchive","representatives.create","representatives.update","representatives.archive","representatives.unarchive","payment_terms.create","payment_terms.update","ledger_accounts.create","ledger_accounts.update"]},"status":{"type":"string","enum":["ready","blocked"]},"wouldWrite":{"type":"boolean","enum":[false]},"submit":{"type":"object","properties":{"method":{"type":"string","enum":["POST","PATCH","PUT","DELETE"]},"path":{"type":"string"},"query":{"type":"object","properties":{},"additionalProperties":false}},"required":["method","path","query"],"additionalProperties":false},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false},"checks":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["not_direct_ship","address_role_required","address_role_valid","already_assigned","already_exists","active_duplicate","ambiguous_external_id","ambiguous_natural_key","api_created","archived_target","archived_record","archive_blocked","account_type_locked","duplicate_candidate_found","duplicate_candidate_overflow","duplicate_check_clear","duplicate_check_not_needed","duplicate_contact","duplicate_customer","duplicate_customer_address","duplicate_customer_location","duplicate_note","duplicate_resolution_applied","duplicate_supplier","duplicate_supplier_ship_from_location","document_url_org_scoped","document_url_valid","upload_verified","sds_converged","idempotency_available","idempotency_key_required","idempotency_key_reused","idempotency_replay","idempotency_target_missing","income_statement_type_invalid","hard_identity_clear","nested_external_id_clear","commercial_references_valid","credit_denomination_mismatch","customer_service_representative_reference_active","ledger_account_reference_valid","payment_terms_reference_exists","sales_person_reference_active","supplier_representative_reference_active","duplicate_reference_identity","external_id_conflict","if_match_current","base_uom_transition_allowed","base_uom_transition_blocked","attribute_assignments_valid","attribute_assignments_invalid","selected_supplier_link","linked_records_available","natural_key_conflict","not_api_created","no_downstream_mutation","order_sensitive_update_allowed","order_sensitive_update_blocked","parent_available","cost_book_entry_blocked","cost_book_entry_valid","cost_book_reference_not_visible","unsupported_cost_book_uom","cost_uom_conversion_unavailable","cost_book_base_unavailable","cost_book_base_ambiguous","cost_ship_from_location_not_visible","cost_package_quantity_invalid","cost_component_invalid","cost_date_window_invalid","cost_date_overlap","cost_amount_overflow","cost_book_conflict","product_family_reference_active","product_packaging_reference_active","primary_child_available","primary_change_unsupported","reference_visibility_blocked","scope_authorized","stale_record","stale_cost_book_entry","supplier_reference_active","tag_applicable","tag_available","tag_exists","tag_found","tag_not_applicable","tag_not_found","type_immutable","type_known","type_required","target_active","target_available","target_not_found_or_not_visible","targets_visible","unsupported_linked_record","unsupported_profile_shape","variable_qty_valid","validation_failed","value_nonempty"]},"status":{"type":"string","enum":["passed","blocked"]},"message":{"type":"string"},"param":{"type":"string"}},"required":["code","status","message"],"additionalProperties":false}},"duplicateCandidates":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact","customer","supplier","customer_location","customer_address","supplier_ship_from_location","product","product_family","document"]},"readable":{"type":"boolean"},"version":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","product","purchase_order"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"matchReasons":{"type":"array","items":{"type":"string","enum":["name","email","externalId","address","code","product","url"]}},"readbackPath":{"type":"string"}},"required":["type","readable","matchReasons"],"additionalProperties":false}},"idempotency":{"type":"object","properties":{"required":{"type":"boolean"},"keyProvided":{"type":"boolean"},"wouldReplay":{"type":"boolean"}},"required":["required","keyProvided","wouldReplay"],"additionalProperties":false},"wouldChange":{"type":"object","properties":{"fieldNames":{"type":"array","items":{"type":"string"}},"values":{"type":"object","additionalProperties":{}}},"required":["fieldNames","values"],"additionalProperties":false},"impactAnalysis":{"type":"object","additionalProperties":{}},"requestId":{"type":"string"}},"required":["type","operation","status","wouldWrite","submit","verification","checks","duplicateCandidates","requestId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}]}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested parent or record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"409":{"description":"The write conflicted with an existing record, idempotency payload, or stale If-Match value.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/contacts":{"get":{"operationId":"listPublicAPIContacts","summary":"List contacts under one parent","description":"Returns contact summaries scoped to one visible customer or supplier parent. This is not a broad contact export.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"contacts:read","parameters":[{"schema":{"type":"string","enum":["customer","supplier"]},"required":true,"name":"parentType","in":"query"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"parentId","in":"query"},{"schema":{"type":"string","minLength":2,"maxLength":120},"required":false,"name":"q","in":"query"},{"schema":{"type":"string","minLength":1,"maxLength":120},"required":false,"name":"externalId","in":"query"},{"schema":{"type":"string"},"required":false,"name":"limit","in":"query"},{"schema":{"type":"string","enum":["true","false"]},"required":false,"name":"includeArchived","in":"query"}],"responses":{"200":{"description":"Parent-scoped contact summaries.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact"]},"id":{"type":"string","format":"uuid"},"contactKind":{"type":"string","enum":["customer","supplier"]},"displayName":{"type":"string"},"url":{"type":"string"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"archived":{"type":"boolean"},"externalId":{"type":["string","null"]},"name":{"type":"string"},"title":{"type":["string","null"]},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"mobilePhone":{"type":["string","null"]},"faxNumber":{"type":["string","null"]},"isEmergency":{"type":"boolean"},"documentTypes":{"type":"array","items":{"anyOf":[{"type":"string","enum":["AR_LETTER","PRICE_QUOTE","SALES_CONFIRMATION","INVOICE","CREDIT_NOTE"]},{"type":"string","enum":["PURCHASE_ORDERS","BILLS","MARKETING","LOGISTICS","WAREHOUSE","CALL_REPORTS"]}]}},"updatedAt":{"type":"string","format":"date-time"}},"required":["type","id","contactKind","displayName","url","parent","archived","externalId","name","title","email","phone","mobilePhone","faxNumber","isEmergency","documentTypes","updatedAt"],"additionalProperties":false}},"meta":{"type":"object","properties":{"requestId":{"type":"string"},"mode":{"type":"string"},"limit":{"type":"integer"},"hasMore":{"type":"boolean"},"filters":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"changedRecordBasis":{"type":"string","enum":["parent_updated_at"]},"narrowingHints":{"type":"array","items":{"type":"string"}}},"required":["requestId","mode","limit","hasMore","filters"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}},"post":{"operationId":"createPublicAPIContact","summary":"Create a customer or supplier contact","description":"Creates a contact under an active customer or supplier parent. Execute requests require Idempotency-Key. dryRun=true may omit Idempotency-Key and returns a blocked readiness check instead of writing.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"contacts:create","parameters":[{"schema":{"type":"string","enum":["true"]},"required":false,"name":"dryRun","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Required for execute requests. dryRun=true may omit this header and receive an idempotency_key_required check."},"required":false,"description":"Required for execute requests. dryRun=true may omit this header and receive an idempotency_key_required check.","name":"Idempotency-Key","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"additionalProperties":false},"name":{"type":"string","minLength":1,"maxLength":160},"title":{"type":["string","null"],"maxLength":160},"email":{"type":["string","null"],"maxLength":240,"format":"email"},"phone":{"type":["string","null"],"maxLength":80},"mobilePhone":{"type":["string","null"],"maxLength":80},"faxNumber":{"type":["string","null"],"maxLength":80},"isEmergency":{"type":"boolean"},"documentTypes":{"type":"array","items":{"anyOf":[{"type":"string","enum":["AR_LETTER","PRICE_QUOTE","SALES_CONFIRMATION","INVOICE","CREDIT_NOTE"]},{"type":"string","enum":["PURCHASE_ORDERS","BILLS","MARKETING","LOGISTICS","WAREHOUSE","CALL_REPORTS"]}]},"maxItems":10},"externalId":{"type":["string","null"],"maxLength":120},"duplicateResolution":{"type":"string","enum":["create_distinct"]}},"required":["parent","name"],"additionalProperties":false}}}},"responses":{"200":{"description":"Idempotent replay returned the existing contact, or dryRun returned write readiness.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["contact"]},"id":{"type":"string","format":"uuid"},"contactKind":{"type":"string","enum":["customer","supplier"]},"displayName":{"type":"string"},"subtitle":{"type":"string"},"url":{"type":"string"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"name":{"type":"string"},"externalId":{"type":["string","null"]},"title":{"type":["string","null"]},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"mobilePhone":{"type":["string","null"]},"faxNumber":{"type":["string","null"]},"isEmergency":{"type":"boolean"},"documentTypes":{"type":"array","items":{"anyOf":[{"type":"string","enum":["AR_LETTER","PRICE_QUOTE","SALES_CONFIRMATION","INVOICE","CREDIT_NOTE"]},{"type":"string","enum":["PURCHASE_ORDERS","BILLS","MARKETING","LOGISTICS","WAREHOUSE","CALL_REPORTS"]}]}},"createdVia":{"type":["object","null"],"properties":{"type":{"type":"string","enum":["public_api"]},"actorUserId":{"type":"string","format":"uuid"}},"required":["type","actorUserId"],"additionalProperties":false},"requestedVia":{"type":"object","properties":{"type":{"type":"string","enum":["api_key"]},"id":{"type":"string","format":"uuid"},"purpose":{"type":["string","null"]}},"required":["type","id","purpose"],"additionalProperties":false},"idempotencyStatus":{"type":"string","enum":["created","replayed","updated","fetched"]}},"required":["type","id","contactKind","displayName","subtitle","url","parent","createdAt","updatedAt","name","externalId","title","email","phone","mobilePhone","faxNumber","isEmergency","documentTypes","createdVia","requestedVia","idempotencyStatus"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["write_readiness"]},"operation":{"type":"string","enum":["warehouses.create","warehouses.update","warehouses.archive","warehouses.unarchive","shipping_options.create","shipping_options.update","shipping_options.archive","shipping_options.unarchive","reorder_points.create","tags.create","tags.update","tag_assignments.create","tag_assignments.delete","notes.create","notes.update","opportunities.create","opportunities.update","opportunities.close","opportunities.meta-upsert","contacts.create","contacts.update","customers.create","customers.update","customer_locations.create","customer_locations.update","customer_addresses.create","customer_addresses.update","suppliers.create","suppliers.update","supplier_ship_from_locations.create","supplier_ship_from_locations.update","products.create","products.update","products.archive","products.unarchive","product_packaging.create","products.suppliers.create","products.suppliers.delete","products.aliases.create","products.aliases.update","products.aliases.delete","product_families.aliases.create","product_families.aliases.update","product_families.aliases.delete","products.customer_part_numbers.create","products.customer_part_numbers.update","products.customer_part_numbers.delete","product_sds.update","product_documents.create","customer_documents.create","supplier_documents.create","purchase_order_documents.create","product_families.create","product_families.update","cost_book_entries.create","current_cost_sources.put","customers.archive","customers.unarchive","suppliers.archive","suppliers.unarchive","contacts.archive","contacts.unarchive","customer_addresses.archive","customer_addresses.unarchive","supplier_ship_from_locations.archive","supplier_ship_from_locations.unarchive","representatives.create","representatives.update","representatives.archive","representatives.unarchive","payment_terms.create","payment_terms.update","ledger_accounts.create","ledger_accounts.update"]},"status":{"type":"string","enum":["ready","blocked"]},"wouldWrite":{"type":"boolean","enum":[false]},"submit":{"type":"object","properties":{"method":{"type":"string","enum":["POST","PATCH","PUT","DELETE"]},"path":{"type":"string"},"query":{"type":"object","properties":{},"additionalProperties":false}},"required":["method","path","query"],"additionalProperties":false},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false},"checks":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["not_direct_ship","address_role_required","address_role_valid","already_assigned","already_exists","active_duplicate","ambiguous_external_id","ambiguous_natural_key","api_created","archived_target","archived_record","archive_blocked","account_type_locked","duplicate_candidate_found","duplicate_candidate_overflow","duplicate_check_clear","duplicate_check_not_needed","duplicate_contact","duplicate_customer","duplicate_customer_address","duplicate_customer_location","duplicate_note","duplicate_resolution_applied","duplicate_supplier","duplicate_supplier_ship_from_location","document_url_org_scoped","document_url_valid","upload_verified","sds_converged","idempotency_available","idempotency_key_required","idempotency_key_reused","idempotency_replay","idempotency_target_missing","income_statement_type_invalid","hard_identity_clear","nested_external_id_clear","commercial_references_valid","credit_denomination_mismatch","customer_service_representative_reference_active","ledger_account_reference_valid","payment_terms_reference_exists","sales_person_reference_active","supplier_representative_reference_active","duplicate_reference_identity","external_id_conflict","if_match_current","base_uom_transition_allowed","base_uom_transition_blocked","attribute_assignments_valid","attribute_assignments_invalid","selected_supplier_link","linked_records_available","natural_key_conflict","not_api_created","no_downstream_mutation","order_sensitive_update_allowed","order_sensitive_update_blocked","parent_available","cost_book_entry_blocked","cost_book_entry_valid","cost_book_reference_not_visible","unsupported_cost_book_uom","cost_uom_conversion_unavailable","cost_book_base_unavailable","cost_book_base_ambiguous","cost_ship_from_location_not_visible","cost_package_quantity_invalid","cost_component_invalid","cost_date_window_invalid","cost_date_overlap","cost_amount_overflow","cost_book_conflict","product_family_reference_active","product_packaging_reference_active","primary_child_available","primary_change_unsupported","reference_visibility_blocked","scope_authorized","stale_record","stale_cost_book_entry","supplier_reference_active","tag_applicable","tag_available","tag_exists","tag_found","tag_not_applicable","tag_not_found","type_immutable","type_known","type_required","target_active","target_available","target_not_found_or_not_visible","targets_visible","unsupported_linked_record","unsupported_profile_shape","variable_qty_valid","validation_failed","value_nonempty"]},"status":{"type":"string","enum":["passed","blocked"]},"message":{"type":"string"},"param":{"type":"string"}},"required":["code","status","message"],"additionalProperties":false}},"duplicateCandidates":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact","customer","supplier","customer_location","customer_address","supplier_ship_from_location","product","product_family","document"]},"readable":{"type":"boolean"},"version":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","product","purchase_order"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"matchReasons":{"type":"array","items":{"type":"string","enum":["name","email","externalId","address","code","product","url"]}},"readbackPath":{"type":"string"}},"required":["type","readable","matchReasons"],"additionalProperties":false}},"idempotency":{"type":"object","properties":{"required":{"type":"boolean"},"keyProvided":{"type":"boolean"},"wouldReplay":{"type":"boolean"}},"required":["required","keyProvided","wouldReplay"],"additionalProperties":false},"wouldChange":{"type":"object","properties":{"fieldNames":{"type":"array","items":{"type":"string"}},"values":{"type":"object","additionalProperties":{}}},"required":["fieldNames","values"],"additionalProperties":false},"impactAnalysis":{"type":"object","additionalProperties":{}},"requestId":{"type":"string"}},"required":["type","operation","status","wouldWrite","submit","verification","checks","duplicateCandidates","requestId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}]}}}},"201":{"description":"Contact created.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["contact"]},"id":{"type":"string","format":"uuid"},"contactKind":{"type":"string","enum":["customer","supplier"]},"displayName":{"type":"string"},"subtitle":{"type":"string"},"url":{"type":"string"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"name":{"type":"string"},"externalId":{"type":["string","null"]},"title":{"type":["string","null"]},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"mobilePhone":{"type":["string","null"]},"faxNumber":{"type":["string","null"]},"isEmergency":{"type":"boolean"},"documentTypes":{"type":"array","items":{"anyOf":[{"type":"string","enum":["AR_LETTER","PRICE_QUOTE","SALES_CONFIRMATION","INVOICE","CREDIT_NOTE"]},{"type":"string","enum":["PURCHASE_ORDERS","BILLS","MARKETING","LOGISTICS","WAREHOUSE","CALL_REPORTS"]}]}},"createdVia":{"type":["object","null"],"properties":{"type":{"type":"string","enum":["public_api"]},"actorUserId":{"type":"string","format":"uuid"}},"required":["type","actorUserId"],"additionalProperties":false},"requestedVia":{"type":"object","properties":{"type":{"type":"string","enum":["api_key"]},"id":{"type":"string","format":"uuid"},"purpose":{"type":["string","null"]}},"required":["type","id","purpose"],"additionalProperties":false},"idempotencyStatus":{"type":"string","enum":["created","replayed","updated","fetched"]}},"required":["type","id","contactKind","displayName","subtitle","url","parent","createdAt","updatedAt","name","externalId","title","email","phone","mobilePhone","faxNumber","isEmergency","documentTypes","createdVia","requestedVia","idempotencyStatus"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested parent or record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"409":{"description":"The write conflicted with an existing record, idempotency payload, or stale If-Match value.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/contacts/{id}":{"get":{"operationId":"getPublicAPIContact","summary":"Get a contact","description":"Returns a customer or supplier contact visible to the acting user.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":["contacts:read","contacts:update","search:read"],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Contact detail.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["contact"]},"id":{"type":"string","format":"uuid"},"contactKind":{"type":"string","enum":["customer","supplier"]},"displayName":{"type":"string"},"subtitle":{"type":"string"},"url":{"type":"string"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"name":{"type":"string"},"externalId":{"type":["string","null"]},"title":{"type":["string","null"]},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"mobilePhone":{"type":["string","null"]},"faxNumber":{"type":["string","null"]},"isEmergency":{"type":"boolean"},"documentTypes":{"type":"array","items":{"anyOf":[{"type":"string","enum":["AR_LETTER","PRICE_QUOTE","SALES_CONFIRMATION","INVOICE","CREDIT_NOTE"]},{"type":"string","enum":["PURCHASE_ORDERS","BILLS","MARKETING","LOGISTICS","WAREHOUSE","CALL_REPORTS"]}]}},"createdVia":{"type":["object","null"],"properties":{"type":{"type":"string","enum":["public_api"]},"actorUserId":{"type":"string","format":"uuid"}},"required":["type","actorUserId"],"additionalProperties":false},"requestedVia":{"type":"object","properties":{"type":{"type":"string","enum":["api_key"]},"id":{"type":"string","format":"uuid"},"purpose":{"type":["string","null"]}},"required":["type","id","purpose"],"additionalProperties":false},"idempotencyStatus":{"type":"string","enum":["created","replayed","updated","fetched"]}},"required":["type","id","contactKind","displayName","subtitle","url","parent","createdAt","updatedAt","name","externalId","title","email","phone","mobilePhone","faxNumber","isEmergency","documentTypes","createdVia","requestedVia","idempotencyStatus"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updatePublicAPIContact","summary":"Update a contact","description":"Updates a customer or supplier contact. Execute requests require If-Match. dryRun=true may omit If-Match and returns a blocked readiness check instead of writing.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"contacts:update","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","enum":["true"]},"required":false,"name":"dryRun","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check."},"required":false,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check.","name":"If-Match","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":160},"title":{"type":["string","null"],"maxLength":160},"email":{"type":["string","null"],"maxLength":240,"format":"email"},"phone":{"type":["string","null"],"maxLength":80},"mobilePhone":{"type":["string","null"],"maxLength":80},"faxNumber":{"type":["string","null"],"maxLength":80},"isEmergency":{"type":"boolean"},"documentTypes":{"type":"array","items":{"anyOf":[{"type":"string","enum":["AR_LETTER","PRICE_QUOTE","SALES_CONFIRMATION","INVOICE","CREDIT_NOTE"]},{"type":"string","enum":["PURCHASE_ORDERS","BILLS","MARKETING","LOGISTICS","WAREHOUSE","CALL_REPORTS"]}]},"maxItems":10},"externalId":{"type":["string","null"],"maxLength":120}},"additionalProperties":false}}}},"responses":{"200":{"description":"Updated contact detail, or dryRun returned write readiness.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["contact"]},"id":{"type":"string","format":"uuid"},"contactKind":{"type":"string","enum":["customer","supplier"]},"displayName":{"type":"string"},"subtitle":{"type":"string"},"url":{"type":"string"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"name":{"type":"string"},"externalId":{"type":["string","null"]},"title":{"type":["string","null"]},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"mobilePhone":{"type":["string","null"]},"faxNumber":{"type":["string","null"]},"isEmergency":{"type":"boolean"},"documentTypes":{"type":"array","items":{"anyOf":[{"type":"string","enum":["AR_LETTER","PRICE_QUOTE","SALES_CONFIRMATION","INVOICE","CREDIT_NOTE"]},{"type":"string","enum":["PURCHASE_ORDERS","BILLS","MARKETING","LOGISTICS","WAREHOUSE","CALL_REPORTS"]}]}},"createdVia":{"type":["object","null"],"properties":{"type":{"type":"string","enum":["public_api"]},"actorUserId":{"type":"string","format":"uuid"}},"required":["type","actorUserId"],"additionalProperties":false},"requestedVia":{"type":"object","properties":{"type":{"type":"string","enum":["api_key"]},"id":{"type":"string","format":"uuid"},"purpose":{"type":["string","null"]}},"required":["type","id","purpose"],"additionalProperties":false},"idempotencyStatus":{"type":"string","enum":["created","replayed","updated","fetched"]}},"required":["type","id","contactKind","displayName","subtitle","url","parent","createdAt","updatedAt","name","externalId","title","email","phone","mobilePhone","faxNumber","isEmergency","documentTypes","createdVia","requestedVia","idempotencyStatus"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["write_readiness"]},"operation":{"type":"string","enum":["warehouses.create","warehouses.update","warehouses.archive","warehouses.unarchive","shipping_options.create","shipping_options.update","shipping_options.archive","shipping_options.unarchive","reorder_points.create","tags.create","tags.update","tag_assignments.create","tag_assignments.delete","notes.create","notes.update","opportunities.create","opportunities.update","opportunities.close","opportunities.meta-upsert","contacts.create","contacts.update","customers.create","customers.update","customer_locations.create","customer_locations.update","customer_addresses.create","customer_addresses.update","suppliers.create","suppliers.update","supplier_ship_from_locations.create","supplier_ship_from_locations.update","products.create","products.update","products.archive","products.unarchive","product_packaging.create","products.suppliers.create","products.suppliers.delete","products.aliases.create","products.aliases.update","products.aliases.delete","product_families.aliases.create","product_families.aliases.update","product_families.aliases.delete","products.customer_part_numbers.create","products.customer_part_numbers.update","products.customer_part_numbers.delete","product_sds.update","product_documents.create","customer_documents.create","supplier_documents.create","purchase_order_documents.create","product_families.create","product_families.update","cost_book_entries.create","current_cost_sources.put","customers.archive","customers.unarchive","suppliers.archive","suppliers.unarchive","contacts.archive","contacts.unarchive","customer_addresses.archive","customer_addresses.unarchive","supplier_ship_from_locations.archive","supplier_ship_from_locations.unarchive","representatives.create","representatives.update","representatives.archive","representatives.unarchive","payment_terms.create","payment_terms.update","ledger_accounts.create","ledger_accounts.update"]},"status":{"type":"string","enum":["ready","blocked"]},"wouldWrite":{"type":"boolean","enum":[false]},"submit":{"type":"object","properties":{"method":{"type":"string","enum":["POST","PATCH","PUT","DELETE"]},"path":{"type":"string"},"query":{"type":"object","properties":{},"additionalProperties":false}},"required":["method","path","query"],"additionalProperties":false},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false},"checks":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["not_direct_ship","address_role_required","address_role_valid","already_assigned","already_exists","active_duplicate","ambiguous_external_id","ambiguous_natural_key","api_created","archived_target","archived_record","archive_blocked","account_type_locked","duplicate_candidate_found","duplicate_candidate_overflow","duplicate_check_clear","duplicate_check_not_needed","duplicate_contact","duplicate_customer","duplicate_customer_address","duplicate_customer_location","duplicate_note","duplicate_resolution_applied","duplicate_supplier","duplicate_supplier_ship_from_location","document_url_org_scoped","document_url_valid","upload_verified","sds_converged","idempotency_available","idempotency_key_required","idempotency_key_reused","idempotency_replay","idempotency_target_missing","income_statement_type_invalid","hard_identity_clear","nested_external_id_clear","commercial_references_valid","credit_denomination_mismatch","customer_service_representative_reference_active","ledger_account_reference_valid","payment_terms_reference_exists","sales_person_reference_active","supplier_representative_reference_active","duplicate_reference_identity","external_id_conflict","if_match_current","base_uom_transition_allowed","base_uom_transition_blocked","attribute_assignments_valid","attribute_assignments_invalid","selected_supplier_link","linked_records_available","natural_key_conflict","not_api_created","no_downstream_mutation","order_sensitive_update_allowed","order_sensitive_update_blocked","parent_available","cost_book_entry_blocked","cost_book_entry_valid","cost_book_reference_not_visible","unsupported_cost_book_uom","cost_uom_conversion_unavailable","cost_book_base_unavailable","cost_book_base_ambiguous","cost_ship_from_location_not_visible","cost_package_quantity_invalid","cost_component_invalid","cost_date_window_invalid","cost_date_overlap","cost_amount_overflow","cost_book_conflict","product_family_reference_active","product_packaging_reference_active","primary_child_available","primary_change_unsupported","reference_visibility_blocked","scope_authorized","stale_record","stale_cost_book_entry","supplier_reference_active","tag_applicable","tag_available","tag_exists","tag_found","tag_not_applicable","tag_not_found","type_immutable","type_known","type_required","target_active","target_available","target_not_found_or_not_visible","targets_visible","unsupported_linked_record","unsupported_profile_shape","variable_qty_valid","validation_failed","value_nonempty"]},"status":{"type":"string","enum":["passed","blocked"]},"message":{"type":"string"},"param":{"type":"string"}},"required":["code","status","message"],"additionalProperties":false}},"duplicateCandidates":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact","customer","supplier","customer_location","customer_address","supplier_ship_from_location","product","product_family","document"]},"readable":{"type":"boolean"},"version":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","product","purchase_order"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"matchReasons":{"type":"array","items":{"type":"string","enum":["name","email","externalId","address","code","product","url"]}},"readbackPath":{"type":"string"}},"required":["type","readable","matchReasons"],"additionalProperties":false}},"idempotency":{"type":"object","properties":{"required":{"type":"boolean"},"keyProvided":{"type":"boolean"},"wouldReplay":{"type":"boolean"}},"required":["required","keyProvided","wouldReplay"],"additionalProperties":false},"wouldChange":{"type":"object","properties":{"fieldNames":{"type":"array","items":{"type":"string"}},"values":{"type":"object","additionalProperties":{}}},"required":["fieldNames","values"],"additionalProperties":false},"impactAnalysis":{"type":"object","additionalProperties":{}},"requestId":{"type":"string"}},"required":["type","operation","status","wouldWrite","submit","verification","checks","duplicateCandidates","requestId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}]}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested parent or record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"409":{"description":"The write conflicted with an existing record, idempotency payload, or stale If-Match value.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/customers":{"get":{"operationId":"findPublicAPICustomers","summary":"Find customers","description":"Finds customer accounts by familiar identity, commercial setup, activity, creator, or created time. When creator or created-time filters are used without pipelineStatus, every pipeline status is included.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"customers:read","parameters":[{"schema":{"type":"string"},"required":false,"name":"q","in":"query"},{"schema":{"type":"string"},"required":false,"name":"externalId","in":"query"},{"schema":{"type":"string","format":"uuid"},"required":false,"name":"createdById","in":"query"},{"schema":{"type":"string","format":"date-time"},"required":false,"name":"createdFrom","in":"query"},{"schema":{"type":"string","format":"date-time"},"required":false,"name":"createdTo","in":"query"},{"schema":{"type":"string","enum":["ACTIVE","PROSPECT"],"description":"Omit to include every pipeline status. Set ACTIVE or PROSPECT to narrow."},"required":false,"description":"Omit to include every pipeline status. Set ACTIVE or PROSPECT to narrow.","name":"pipelineStatus","in":"query"},{"schema":{"type":"string"},"required":false,"name":"limit","in":"query"},{"schema":{"type":"string"},"required":false,"name":"includeArchived","in":"query"},{"schema":{"type":"string","format":"uuid"},"required":false,"name":"salesPersonId","in":"query"},{"schema":{"type":"string","enum":["all","mine","unassigned"]},"required":false,"name":"salesOwnership","in":"query"},{"schema":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"required":false,"name":"setupIssues","in":"query"},{"schema":{"type":"string","enum":["any","none"]},"required":false,"name":"salesActivity","in":"query"},{"schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"required":false,"name":"salesFrom","in":"query"},{"schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"required":false,"name":"salesTo","in":"query"},{"schema":{"type":"string"},"required":false,"name":"cursor","in":"query"}],"responses":{"200":{"description":"Customer finder summaries.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["customer"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"externalId":{"type":["string","null"]},"pipelineStatus":{"type":["string","null"]},"primaryLocation":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"primary":{"type":"boolean"},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"website":{"type":["string","null"]},"updatedAt":{"type":"string","format":"date-time"},"accountOwner":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":["string","null"]},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"}},"required":["id","firstName","lastName","externalId","archivedAt"],"additionalProperties":false},"paymentTerms":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"externalId":{"type":["string","null"]}},"required":["id","name","externalId"],"additionalProperties":false},"customerServiceRepresentative":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":["string","null"]},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"}},"required":["id","firstName","lastName","externalId","archivedAt"],"additionalProperties":false},"archived":{"type":"boolean"}},"required":["id","name","primary","email","phone","website","updatedAt","accountOwner","paymentTerms","customerServiceRepresentative","archived"],"additionalProperties":false},"primaryAddress":{"type":["object","null"],"properties":{"id":{"type":["string","null"],"format":"uuid"},"name":{"type":["string","null"]},"street1":{"type":["string","null"]},"street2":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"zip":{"type":["string","null"]},"country":{"type":["string","null"]},"phone":{"type":["string","null"]},"email":{"type":["string","null"]}},"required":["id","name","street1","street2","city","state","zip","country","phone","email"],"additionalProperties":false},"owners":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":["string","null"]},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"}},"required":["id","firstName","lastName","externalId","archivedAt"],"additionalProperties":false}},"commercialTermsState":{"type":"string","enum":["resolved","no_primary","ambiguous_primary"]},"primaryOwner":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":["string","null"]},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"}},"required":["id","firstName","lastName","externalId","archivedAt"],"additionalProperties":false},"paymentTerms":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"externalId":{"type":["string","null"]}},"required":["id","name","externalId"],"additionalProperties":false},"customerServiceRepresentative":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":["string","null"]},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"}},"required":["id","firstName","lastName","externalId","archivedAt"],"additionalProperties":false},"accountManager":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]}},"required":["id","firstName","lastName"],"additionalProperties":false},"locations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"primary":{"type":"boolean"},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"website":{"type":["string","null"]},"updatedAt":{"type":"string","format":"date-time"},"accountOwner":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":["string","null"]},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"}},"required":["id","firstName","lastName","externalId","archivedAt"],"additionalProperties":false},"paymentTerms":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"externalId":{"type":["string","null"]}},"required":["id","name","externalId"],"additionalProperties":false},"customerServiceRepresentative":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":["string","null"]},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"}},"required":["id","firstName","lastName","externalId","archivedAt"],"additionalProperties":false}},"required":["id","name","primary","email","phone","website","updatedAt","accountOwner","paymentTerms","customerServiceRepresentative"],"additionalProperties":false}},"locationCoverage":{"type":"object","properties":{"total":{"type":"integer"},"returned":{"type":"integer"},"truncated":{"type":"boolean"},"readbackPath":{"type":["string","null"]}},"required":["total","returned","truncated","readbackPath"],"additionalProperties":false},"url":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["user"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["system"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string","enum":["System User"]}},"required":["type","id","displayName"],"additionalProperties":false}]},"archived":{"type":"boolean"}},"required":["type","id","displayName","externalId","pipelineStatus","primaryLocation","primaryAddress","owners","commercialTermsState","primaryOwner","paymentTerms","customerServiceRepresentative","accountManager","locations","locationCoverage","url","updatedAt","createdAt","createdBy","archived"],"additionalProperties":false}},"meta":{"type":"object","properties":{"requestId":{"type":"string"},"mode":{"type":"string"},"limit":{"type":"integer"},"hasMore":{"type":"boolean"},"filters":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"changedRecordBasis":{"type":"string","enum":["parent_updated_at"]},"narrowingHints":{"type":"array","items":{"type":"string"}},"nextCursor":{"type":["string","null"]},"coverage":{"type":"object","properties":{"totalAccounts":{"type":"integer"},"returnedAccounts":{"type":"integer"},"truncated":{"type":"boolean"},"rowScope":{"type":"string","enum":["organization","assigned_salesperson"]},"negativeClosureEligible":{"type":"boolean"},"actorNotSalesperson":{"type":"boolean"},"activityBasis":{"type":"object","properties":{"applied":{"type":"boolean"},"presence":{"type":["string","null"],"enum":["any","none"]},"fromDate":{"type":["string","null"]},"toDate":{"type":["string","null"]},"definition":{"type":["string","null"]}},"required":["applied","presence","fromDate","toDate","definition"],"additionalProperties":false}},"required":["totalAccounts","returnedAccounts","truncated","rowScope","negativeClosureEligible","actorNotSalesperson","activityBasis"],"additionalProperties":false}},"required":["requestId","mode","limit","hasMore","filters","nextCursor","coverage"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}},"post":{"operationId":"createPublicAPICustomerProfile","summary":"Create a customer profile","description":"Creates a bounded customer profile with one primary location and one billing/shipping address bundle. Execute requests require Idempotency-Key. dryRun=true may omit Idempotency-Key and returns a blocked readiness check instead of writing.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"customers:write","parameters":[{"schema":{"type":"string","enum":["true"]},"required":false,"name":"dryRun","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Required for execute requests. dryRun=true may omit this header and receive an idempotency_key_required check."},"required":false,"description":"Required for execute requests. dryRun=true may omit this header and receive an idempotency_key_required check.","name":"Idempotency-Key","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":160},"externalId":{"type":["string","null"],"maxLength":120},"pipelineStatus":{"type":"string","enum":["ACTIVE","PROSPECT"],"default":"PROSPECT"},"primaryLocation":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":160},"email":{"type":["string","null"],"maxLength":240},"website":{"type":["string","null"],"maxLength":240},"phone":{"type":["string","null"],"maxLength":80},"accountOwnerId":{"type":["string","null"],"format":"uuid"},"paymentTermsId":{"type":["string","null"],"format":"uuid"},"customerServiceRepresentativeId":{"type":["string","null"],"format":"uuid"},"creditLimit":{"type":["object","null"],"properties":{"amountCents":{"type":["integer","null"],"minimum":0,"maximum":2147483647},"currencyCode":{"type":"string","minLength":3,"maxLength":3}},"required":["amountCents"],"additionalProperties":false},"address":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":160},"street1":{"type":["string","null"],"maxLength":240},"street2":{"type":["string","null"],"maxLength":240},"city":{"type":["string","null"],"maxLength":120},"state":{"type":["string","null"],"maxLength":80},"zip":{"type":["string","null"],"maxLength":40},"country":{"type":["string","null"],"maxLength":80},"email":{"type":["string","null"],"maxLength":240},"phone":{"type":["string","null"],"maxLength":80},"defaultOrderShippingRemarks":{"type":["string","null"],"maxLength":2000},"externalId":{"type":["string","null"],"maxLength":120},"isBilling":{"type":"boolean"},"isShipping":{"type":"boolean"}},"additionalProperties":false}},"additionalProperties":false},"duplicateResolution":{"type":"string","enum":["create_distinct"]}},"required":["name"],"additionalProperties":false}}}},"responses":{"200":{"description":"Idempotent replay returned the existing customer profile, or dryRun returned write readiness.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["customer"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"url":{"type":"string"},"archived":{"type":"boolean"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"externalId":{"type":["string","null"]},"pipelineStatus":{"type":["string","null"]},"owners":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":["string","null"]},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"}},"required":["id","firstName","lastName","externalId","archivedAt"],"additionalProperties":false}},"commercialTermsState":{"type":"string","enum":["resolved","no_primary","ambiguous_primary"]},"primaryOwner":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":["string","null"]},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"}},"required":["id","firstName","lastName","externalId","archivedAt"],"additionalProperties":false},"paymentTerms":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"externalId":{"type":["string","null"]}},"required":["id","name","externalId"],"additionalProperties":false},"customerServiceRepresentative":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":["string","null"]},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"}},"required":["id","firstName","lastName","externalId","archivedAt"],"additionalProperties":false},"accountManager":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]}},"required":["id","firstName","lastName"],"additionalProperties":false},"primaryLocation":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"website":{"type":["string","null"]},"archived":{"type":"boolean"},"creditLimit":{"type":"object","properties":{"amountCents":{"type":["integer","null"],"minimum":0,"maximum":2147483647},"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"}},"required":["amountCents","currencyCode"],"additionalProperties":false},"accountOwner":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":["string","null"]},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"}},"required":["id","firstName","lastName","externalId","archivedAt"],"additionalProperties":false},"paymentTerms":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"externalId":{"type":["string","null"]}},"required":["id","name","externalId"],"additionalProperties":false},"customerServiceRepresentative":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":["string","null"]},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"}},"required":["id","firstName","lastName","externalId","archivedAt"],"additionalProperties":false},"accountManager":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]}},"required":["id","firstName","lastName"],"additionalProperties":false}},"required":["id","name","email","phone","website","archived","creditLimit","accountOwner","paymentTerms","customerServiceRepresentative","accountManager"],"additionalProperties":false},"locations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"primary":{"type":"boolean"},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"website":{"type":["string","null"]},"archived":{"type":"boolean"},"creditLimit":{"type":"object","properties":{"amountCents":{"type":["integer","null"],"minimum":0,"maximum":2147483647},"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"}},"required":["amountCents","currencyCode"],"additionalProperties":false},"accountOwner":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":["string","null"]},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"}},"required":["id","firstName","lastName","externalId","archivedAt"],"additionalProperties":false},"paymentTerms":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"externalId":{"type":["string","null"]}},"required":["id","name","externalId"],"additionalProperties":false},"customerServiceRepresentative":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":["string","null"]},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"}},"required":["id","firstName","lastName","externalId","archivedAt"],"additionalProperties":false},"accountManager":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]}},"required":["id","firstName","lastName"],"additionalProperties":false}},"required":["id","name","primary","email","phone","website","archived","creditLimit","accountOwner","paymentTerms","customerServiceRepresentative","accountManager"],"additionalProperties":false}},"addresses":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"street1":{"type":["string","null"]},"street2":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"zip":{"type":["string","null"]},"country":{"type":["string","null"]},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"externalId":{"type":["string","null"]},"isBilling":{"type":"boolean"},"isShipping":{"type":"boolean"},"defaultOrderShippingRemarks":{"type":["string","null"]},"archived":{"type":"boolean"},"location":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"primary":{"type":"boolean"}},"required":["id","name","primary"],"additionalProperties":false}},"required":["id","name","street1","street2","city","state","zip","country","email","phone","externalId","isBilling","isShipping","defaultOrderShippingRemarks","archived","location"],"additionalProperties":false}},"contacts":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact"]},"id":{"type":"string","format":"uuid"},"contactKind":{"type":"string","enum":["customer","supplier"]},"displayName":{"type":"string"},"url":{"type":"string"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"archived":{"type":"boolean"},"externalId":{"type":["string","null"]},"name":{"type":"string"},"title":{"type":["string","null"]},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"mobilePhone":{"type":["string","null"]},"faxNumber":{"type":["string","null"]},"isEmergency":{"type":"boolean"},"documentTypes":{"type":"array","items":{"anyOf":[{"type":"string","enum":["AR_LETTER","PRICE_QUOTE","SALES_CONFIRMATION","INVOICE","CREDIT_NOTE"]},{"type":"string","enum":["PURCHASE_ORDERS","BILLS","MARKETING","LOGISTICS","WAREHOUSE","CALL_REPORTS"]}]}}},"required":["type","id","contactKind","displayName","url","parent","archived","externalId","name","title","email","phone","mobilePhone","faxNumber","isEmergency","documentTypes"],"additionalProperties":false}}},"required":["type","id","displayName","url","archived","createdAt","updatedAt","externalId","pipelineStatus","owners","commercialTermsState","primaryOwner","paymentTerms","customerServiceRepresentative","accountManager","primaryLocation","locations","addresses","contacts"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["write_readiness"]},"operation":{"type":"string","enum":["warehouses.create","warehouses.update","warehouses.archive","warehouses.unarchive","shipping_options.create","shipping_options.update","shipping_options.archive","shipping_options.unarchive","reorder_points.create","tags.create","tags.update","tag_assignments.create","tag_assignments.delete","notes.create","notes.update","opportunities.create","opportunities.update","opportunities.close","opportunities.meta-upsert","contacts.create","contacts.update","customers.create","customers.update","customer_locations.create","customer_locations.update","customer_addresses.create","customer_addresses.update","suppliers.create","suppliers.update","supplier_ship_from_locations.create","supplier_ship_from_locations.update","products.create","products.update","products.archive","products.unarchive","product_packaging.create","products.suppliers.create","products.suppliers.delete","products.aliases.create","products.aliases.update","products.aliases.delete","product_families.aliases.create","product_families.aliases.update","product_families.aliases.delete","products.customer_part_numbers.create","products.customer_part_numbers.update","products.customer_part_numbers.delete","product_sds.update","product_documents.create","customer_documents.create","supplier_documents.create","purchase_order_documents.create","product_families.create","product_families.update","cost_book_entries.create","current_cost_sources.put","customers.archive","customers.unarchive","suppliers.archive","suppliers.unarchive","contacts.archive","contacts.unarchive","customer_addresses.archive","customer_addresses.unarchive","supplier_ship_from_locations.archive","supplier_ship_from_locations.unarchive","representatives.create","representatives.update","representatives.archive","representatives.unarchive","payment_terms.create","payment_terms.update","ledger_accounts.create","ledger_accounts.update"]},"status":{"type":"string","enum":["ready","blocked"]},"wouldWrite":{"type":"boolean","enum":[false]},"submit":{"type":"object","properties":{"method":{"type":"string","enum":["POST","PATCH","PUT","DELETE"]},"path":{"type":"string"},"query":{"type":"object","properties":{},"additionalProperties":false}},"required":["method","path","query"],"additionalProperties":false},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false},"checks":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["not_direct_ship","address_role_required","address_role_valid","already_assigned","already_exists","active_duplicate","ambiguous_external_id","ambiguous_natural_key","api_created","archived_target","archived_record","archive_blocked","account_type_locked","duplicate_candidate_found","duplicate_candidate_overflow","duplicate_check_clear","duplicate_check_not_needed","duplicate_contact","duplicate_customer","duplicate_customer_address","duplicate_customer_location","duplicate_note","duplicate_resolution_applied","duplicate_supplier","duplicate_supplier_ship_from_location","document_url_org_scoped","document_url_valid","upload_verified","sds_converged","idempotency_available","idempotency_key_required","idempotency_key_reused","idempotency_replay","idempotency_target_missing","income_statement_type_invalid","hard_identity_clear","nested_external_id_clear","commercial_references_valid","credit_denomination_mismatch","customer_service_representative_reference_active","ledger_account_reference_valid","payment_terms_reference_exists","sales_person_reference_active","supplier_representative_reference_active","duplicate_reference_identity","external_id_conflict","if_match_current","base_uom_transition_allowed","base_uom_transition_blocked","attribute_assignments_valid","attribute_assignments_invalid","selected_supplier_link","linked_records_available","natural_key_conflict","not_api_created","no_downstream_mutation","order_sensitive_update_allowed","order_sensitive_update_blocked","parent_available","cost_book_entry_blocked","cost_book_entry_valid","cost_book_reference_not_visible","unsupported_cost_book_uom","cost_uom_conversion_unavailable","cost_book_base_unavailable","cost_book_base_ambiguous","cost_ship_from_location_not_visible","cost_package_quantity_invalid","cost_component_invalid","cost_date_window_invalid","cost_date_overlap","cost_amount_overflow","cost_book_conflict","product_family_reference_active","product_packaging_reference_active","primary_child_available","primary_change_unsupported","reference_visibility_blocked","scope_authorized","stale_record","stale_cost_book_entry","supplier_reference_active","tag_applicable","tag_available","tag_exists","tag_found","tag_not_applicable","tag_not_found","type_immutable","type_known","type_required","target_active","target_available","target_not_found_or_not_visible","targets_visible","unsupported_linked_record","unsupported_profile_shape","variable_qty_valid","validation_failed","value_nonempty"]},"status":{"type":"string","enum":["passed","blocked"]},"message":{"type":"string"},"param":{"type":"string"}},"required":["code","status","message"],"additionalProperties":false}},"duplicateCandidates":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact","customer","supplier","customer_location","customer_address","supplier_ship_from_location","product","product_family","document"]},"readable":{"type":"boolean"},"version":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","product","purchase_order"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"matchReasons":{"type":"array","items":{"type":"string","enum":["name","email","externalId","address","code","product","url"]}},"readbackPath":{"type":"string"}},"required":["type","readable","matchReasons"],"additionalProperties":false}},"idempotency":{"type":"object","properties":{"required":{"type":"boolean"},"keyProvided":{"type":"boolean"},"wouldReplay":{"type":"boolean"}},"required":["required","keyProvided","wouldReplay"],"additionalProperties":false},"wouldChange":{"type":"object","properties":{"fieldNames":{"type":"array","items":{"type":"string"}},"values":{"type":"object","additionalProperties":{}}},"required":["fieldNames","values"],"additionalProperties":false},"impactAnalysis":{"type":"object","additionalProperties":{}},"requestId":{"type":"string"}},"required":["type","operation","status","wouldWrite","submit","verification","checks","duplicateCandidates","requestId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}]}}}},"201":{"description":"Customer profile created.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["customer"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"url":{"type":"string"},"archived":{"type":"boolean"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"externalId":{"type":["string","null"]},"pipelineStatus":{"type":["string","null"]},"owners":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":["string","null"]},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"}},"required":["id","firstName","lastName","externalId","archivedAt"],"additionalProperties":false}},"commercialTermsState":{"type":"string","enum":["resolved","no_primary","ambiguous_primary"]},"primaryOwner":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":["string","null"]},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"}},"required":["id","firstName","lastName","externalId","archivedAt"],"additionalProperties":false},"paymentTerms":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"externalId":{"type":["string","null"]}},"required":["id","name","externalId"],"additionalProperties":false},"customerServiceRepresentative":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":["string","null"]},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"}},"required":["id","firstName","lastName","externalId","archivedAt"],"additionalProperties":false},"accountManager":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]}},"required":["id","firstName","lastName"],"additionalProperties":false},"primaryLocation":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"website":{"type":["string","null"]},"archived":{"type":"boolean"},"creditLimit":{"type":"object","properties":{"amountCents":{"type":["integer","null"],"minimum":0,"maximum":2147483647},"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"}},"required":["amountCents","currencyCode"],"additionalProperties":false},"accountOwner":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":["string","null"]},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"}},"required":["id","firstName","lastName","externalId","archivedAt"],"additionalProperties":false},"paymentTerms":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"externalId":{"type":["string","null"]}},"required":["id","name","externalId"],"additionalProperties":false},"customerServiceRepresentative":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":["string","null"]},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"}},"required":["id","firstName","lastName","externalId","archivedAt"],"additionalProperties":false},"accountManager":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]}},"required":["id","firstName","lastName"],"additionalProperties":false}},"required":["id","name","email","phone","website","archived","creditLimit","accountOwner","paymentTerms","customerServiceRepresentative","accountManager"],"additionalProperties":false},"locations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"primary":{"type":"boolean"},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"website":{"type":["string","null"]},"archived":{"type":"boolean"},"creditLimit":{"type":"object","properties":{"amountCents":{"type":["integer","null"],"minimum":0,"maximum":2147483647},"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"}},"required":["amountCents","currencyCode"],"additionalProperties":false},"accountOwner":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":["string","null"]},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"}},"required":["id","firstName","lastName","externalId","archivedAt"],"additionalProperties":false},"paymentTerms":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"externalId":{"type":["string","null"]}},"required":["id","name","externalId"],"additionalProperties":false},"customerServiceRepresentative":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":["string","null"]},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"}},"required":["id","firstName","lastName","externalId","archivedAt"],"additionalProperties":false},"accountManager":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]}},"required":["id","firstName","lastName"],"additionalProperties":false}},"required":["id","name","primary","email","phone","website","archived","creditLimit","accountOwner","paymentTerms","customerServiceRepresentative","accountManager"],"additionalProperties":false}},"addresses":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"street1":{"type":["string","null"]},"street2":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"zip":{"type":["string","null"]},"country":{"type":["string","null"]},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"externalId":{"type":["string","null"]},"isBilling":{"type":"boolean"},"isShipping":{"type":"boolean"},"defaultOrderShippingRemarks":{"type":["string","null"]},"archived":{"type":"boolean"},"location":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"primary":{"type":"boolean"}},"required":["id","name","primary"],"additionalProperties":false}},"required":["id","name","street1","street2","city","state","zip","country","email","phone","externalId","isBilling","isShipping","defaultOrderShippingRemarks","archived","location"],"additionalProperties":false}},"contacts":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact"]},"id":{"type":"string","format":"uuid"},"contactKind":{"type":"string","enum":["customer","supplier"]},"displayName":{"type":"string"},"url":{"type":"string"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"archived":{"type":"boolean"},"externalId":{"type":["string","null"]},"name":{"type":"string"},"title":{"type":["string","null"]},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"mobilePhone":{"type":["string","null"]},"faxNumber":{"type":["string","null"]},"isEmergency":{"type":"boolean"},"documentTypes":{"type":"array","items":{"anyOf":[{"type":"string","enum":["AR_LETTER","PRICE_QUOTE","SALES_CONFIRMATION","INVOICE","CREDIT_NOTE"]},{"type":"string","enum":["PURCHASE_ORDERS","BILLS","MARKETING","LOGISTICS","WAREHOUSE","CALL_REPORTS"]}]}}},"required":["type","id","contactKind","displayName","url","parent","archived","externalId","name","title","email","phone","mobilePhone","faxNumber","isEmergency","documentTypes"],"additionalProperties":false}}},"required":["type","id","displayName","url","archived","createdAt","updatedAt","externalId","pipelineStatus","owners","commercialTermsState","primaryOwner","paymentTerms","customerServiceRepresentative","accountManager","primaryLocation","locations","addresses","contacts"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested parent or record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"409":{"description":"The write conflicted with an existing record, idempotency payload, or stale If-Match value.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/customers/{id}":{"get":{"operationId":"getPublicAPICustomer","summary":"Get a customer","description":"Returns a safe read-only customer detail DTO visible to the acting user.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":["customers:read","search:read"],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Customer detail.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["customer"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"url":{"type":"string"},"archived":{"type":"boolean"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"externalId":{"type":["string","null"]},"pipelineStatus":{"type":["string","null"]},"owners":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":["string","null"]},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"}},"required":["id","firstName","lastName","externalId","archivedAt"],"additionalProperties":false}},"commercialTermsState":{"type":"string","enum":["resolved","no_primary","ambiguous_primary"]},"primaryOwner":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":["string","null"]},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"}},"required":["id","firstName","lastName","externalId","archivedAt"],"additionalProperties":false},"paymentTerms":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"externalId":{"type":["string","null"]}},"required":["id","name","externalId"],"additionalProperties":false},"customerServiceRepresentative":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":["string","null"]},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"}},"required":["id","firstName","lastName","externalId","archivedAt"],"additionalProperties":false},"accountManager":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]}},"required":["id","firstName","lastName"],"additionalProperties":false},"primaryLocation":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"website":{"type":["string","null"]},"archived":{"type":"boolean"},"creditLimit":{"type":"object","properties":{"amountCents":{"type":["integer","null"],"minimum":0,"maximum":2147483647},"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"}},"required":["amountCents","currencyCode"],"additionalProperties":false},"accountOwner":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":["string","null"]},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"}},"required":["id","firstName","lastName","externalId","archivedAt"],"additionalProperties":false},"paymentTerms":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"externalId":{"type":["string","null"]}},"required":["id","name","externalId"],"additionalProperties":false},"customerServiceRepresentative":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":["string","null"]},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"}},"required":["id","firstName","lastName","externalId","archivedAt"],"additionalProperties":false},"accountManager":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]}},"required":["id","firstName","lastName"],"additionalProperties":false}},"required":["id","name","email","phone","website","archived","creditLimit","accountOwner","paymentTerms","customerServiceRepresentative","accountManager"],"additionalProperties":false},"locations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"primary":{"type":"boolean"},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"website":{"type":["string","null"]},"archived":{"type":"boolean"},"creditLimit":{"type":"object","properties":{"amountCents":{"type":["integer","null"],"minimum":0,"maximum":2147483647},"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"}},"required":["amountCents","currencyCode"],"additionalProperties":false},"accountOwner":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":["string","null"]},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"}},"required":["id","firstName","lastName","externalId","archivedAt"],"additionalProperties":false},"paymentTerms":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"externalId":{"type":["string","null"]}},"required":["id","name","externalId"],"additionalProperties":false},"customerServiceRepresentative":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":["string","null"]},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"}},"required":["id","firstName","lastName","externalId","archivedAt"],"additionalProperties":false},"accountManager":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]}},"required":["id","firstName","lastName"],"additionalProperties":false}},"required":["id","name","primary","email","phone","website","archived","creditLimit","accountOwner","paymentTerms","customerServiceRepresentative","accountManager"],"additionalProperties":false}},"addresses":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"street1":{"type":["string","null"]},"street2":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"zip":{"type":["string","null"]},"country":{"type":["string","null"]},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"externalId":{"type":["string","null"]},"isBilling":{"type":"boolean"},"isShipping":{"type":"boolean"},"defaultOrderShippingRemarks":{"type":["string","null"]},"archived":{"type":"boolean"},"location":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"primary":{"type":"boolean"}},"required":["id","name","primary"],"additionalProperties":false}},"required":["id","name","street1","street2","city","state","zip","country","email","phone","externalId","isBilling","isShipping","defaultOrderShippingRemarks","archived","location"],"additionalProperties":false}},"contacts":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact"]},"id":{"type":"string","format":"uuid"},"contactKind":{"type":"string","enum":["customer","supplier"]},"displayName":{"type":"string"},"url":{"type":"string"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"archived":{"type":"boolean"},"externalId":{"type":["string","null"]},"name":{"type":"string"},"title":{"type":["string","null"]},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"mobilePhone":{"type":["string","null"]},"faxNumber":{"type":["string","null"]},"isEmergency":{"type":"boolean"},"documentTypes":{"type":"array","items":{"anyOf":[{"type":"string","enum":["AR_LETTER","PRICE_QUOTE","SALES_CONFIRMATION","INVOICE","CREDIT_NOTE"]},{"type":"string","enum":["PURCHASE_ORDERS","BILLS","MARKETING","LOGISTICS","WAREHOUSE","CALL_REPORTS"]}]}}},"required":["type","id","contactKind","displayName","url","parent","archived","externalId","name","title","email","phone","mobilePhone","faxNumber","isEmergency","documentTypes"],"additionalProperties":false}}},"required":["type","id","displayName","url","archived","createdAt","updatedAt","externalId","pipelineStatus","owners","commercialTermsState","primaryOwner","paymentTerms","customerServiceRepresentative","accountManager","primaryLocation","locations","addresses","contacts"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updatePublicAPICustomerProfile","summary":"Update a customer profile","description":"Updates bounded customer profile fields. Omitted fields are preserved. Execute requests require If-Match. dryRun=true may omit If-Match and returns a blocked readiness check instead of writing.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"customers:write","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","enum":["true"]},"required":false,"name":"dryRun","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check."},"required":false,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check.","name":"If-Match","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":160},"externalId":{"type":["string","null"],"maxLength":120},"pipelineStatus":{"type":"string","enum":["ACTIVE","PROSPECT"]},"primaryLocation":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":160},"email":{"type":["string","null"],"maxLength":240},"website":{"type":["string","null"],"maxLength":240},"phone":{"type":["string","null"],"maxLength":80},"accountOwnerId":{"type":["string","null"],"format":"uuid"},"paymentTermsId":{"type":["string","null"],"format":"uuid"},"customerServiceRepresentativeId":{"type":["string","null"],"format":"uuid"},"creditLimit":{"type":["object","null"],"properties":{"amountCents":{"type":["integer","null"],"minimum":0,"maximum":2147483647},"currencyCode":{"type":"string","minLength":3,"maxLength":3}},"required":["amountCents"],"additionalProperties":false},"address":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":160},"street1":{"type":["string","null"],"maxLength":240},"street2":{"type":["string","null"],"maxLength":240},"city":{"type":["string","null"],"maxLength":120},"state":{"type":["string","null"],"maxLength":80},"zip":{"type":["string","null"],"maxLength":40},"country":{"type":["string","null"],"maxLength":80},"email":{"type":["string","null"],"maxLength":240},"phone":{"type":["string","null"],"maxLength":80},"defaultOrderShippingRemarks":{"type":["string","null"],"maxLength":2000},"externalId":{"type":["string","null"],"maxLength":120},"isBilling":{"type":"boolean"},"isShipping":{"type":"boolean"}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false}}}},"responses":{"200":{"description":"Updated customer profile, or dryRun returned write readiness.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["customer"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"url":{"type":"string"},"archived":{"type":"boolean"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"externalId":{"type":["string","null"]},"pipelineStatus":{"type":["string","null"]},"owners":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":["string","null"]},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"}},"required":["id","firstName","lastName","externalId","archivedAt"],"additionalProperties":false}},"commercialTermsState":{"type":"string","enum":["resolved","no_primary","ambiguous_primary"]},"primaryOwner":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":["string","null"]},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"}},"required":["id","firstName","lastName","externalId","archivedAt"],"additionalProperties":false},"paymentTerms":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"externalId":{"type":["string","null"]}},"required":["id","name","externalId"],"additionalProperties":false},"customerServiceRepresentative":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":["string","null"]},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"}},"required":["id","firstName","lastName","externalId","archivedAt"],"additionalProperties":false},"accountManager":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]}},"required":["id","firstName","lastName"],"additionalProperties":false},"primaryLocation":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"website":{"type":["string","null"]},"archived":{"type":"boolean"},"creditLimit":{"type":"object","properties":{"amountCents":{"type":["integer","null"],"minimum":0,"maximum":2147483647},"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"}},"required":["amountCents","currencyCode"],"additionalProperties":false},"accountOwner":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":["string","null"]},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"}},"required":["id","firstName","lastName","externalId","archivedAt"],"additionalProperties":false},"paymentTerms":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"externalId":{"type":["string","null"]}},"required":["id","name","externalId"],"additionalProperties":false},"customerServiceRepresentative":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":["string","null"]},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"}},"required":["id","firstName","lastName","externalId","archivedAt"],"additionalProperties":false},"accountManager":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]}},"required":["id","firstName","lastName"],"additionalProperties":false}},"required":["id","name","email","phone","website","archived","creditLimit","accountOwner","paymentTerms","customerServiceRepresentative","accountManager"],"additionalProperties":false},"locations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"primary":{"type":"boolean"},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"website":{"type":["string","null"]},"archived":{"type":"boolean"},"creditLimit":{"type":"object","properties":{"amountCents":{"type":["integer","null"],"minimum":0,"maximum":2147483647},"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"}},"required":["amountCents","currencyCode"],"additionalProperties":false},"accountOwner":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":["string","null"]},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"}},"required":["id","firstName","lastName","externalId","archivedAt"],"additionalProperties":false},"paymentTerms":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"externalId":{"type":["string","null"]}},"required":["id","name","externalId"],"additionalProperties":false},"customerServiceRepresentative":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":["string","null"]},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"}},"required":["id","firstName","lastName","externalId","archivedAt"],"additionalProperties":false},"accountManager":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]}},"required":["id","firstName","lastName"],"additionalProperties":false}},"required":["id","name","primary","email","phone","website","archived","creditLimit","accountOwner","paymentTerms","customerServiceRepresentative","accountManager"],"additionalProperties":false}},"addresses":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"street1":{"type":["string","null"]},"street2":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"zip":{"type":["string","null"]},"country":{"type":["string","null"]},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"externalId":{"type":["string","null"]},"isBilling":{"type":"boolean"},"isShipping":{"type":"boolean"},"defaultOrderShippingRemarks":{"type":["string","null"]},"archived":{"type":"boolean"},"location":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"primary":{"type":"boolean"}},"required":["id","name","primary"],"additionalProperties":false}},"required":["id","name","street1","street2","city","state","zip","country","email","phone","externalId","isBilling","isShipping","defaultOrderShippingRemarks","archived","location"],"additionalProperties":false}},"contacts":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact"]},"id":{"type":"string","format":"uuid"},"contactKind":{"type":"string","enum":["customer","supplier"]},"displayName":{"type":"string"},"url":{"type":"string"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"archived":{"type":"boolean"},"externalId":{"type":["string","null"]},"name":{"type":"string"},"title":{"type":["string","null"]},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"mobilePhone":{"type":["string","null"]},"faxNumber":{"type":["string","null"]},"isEmergency":{"type":"boolean"},"documentTypes":{"type":"array","items":{"anyOf":[{"type":"string","enum":["AR_LETTER","PRICE_QUOTE","SALES_CONFIRMATION","INVOICE","CREDIT_NOTE"]},{"type":"string","enum":["PURCHASE_ORDERS","BILLS","MARKETING","LOGISTICS","WAREHOUSE","CALL_REPORTS"]}]}}},"required":["type","id","contactKind","displayName","url","parent","archived","externalId","name","title","email","phone","mobilePhone","faxNumber","isEmergency","documentTypes"],"additionalProperties":false}}},"required":["type","id","displayName","url","archived","createdAt","updatedAt","externalId","pipelineStatus","owners","commercialTermsState","primaryOwner","paymentTerms","customerServiceRepresentative","accountManager","primaryLocation","locations","addresses","contacts"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["write_readiness"]},"operation":{"type":"string","enum":["warehouses.create","warehouses.update","warehouses.archive","warehouses.unarchive","shipping_options.create","shipping_options.update","shipping_options.archive","shipping_options.unarchive","reorder_points.create","tags.create","tags.update","tag_assignments.create","tag_assignments.delete","notes.create","notes.update","opportunities.create","opportunities.update","opportunities.close","opportunities.meta-upsert","contacts.create","contacts.update","customers.create","customers.update","customer_locations.create","customer_locations.update","customer_addresses.create","customer_addresses.update","suppliers.create","suppliers.update","supplier_ship_from_locations.create","supplier_ship_from_locations.update","products.create","products.update","products.archive","products.unarchive","product_packaging.create","products.suppliers.create","products.suppliers.delete","products.aliases.create","products.aliases.update","products.aliases.delete","product_families.aliases.create","product_families.aliases.update","product_families.aliases.delete","products.customer_part_numbers.create","products.customer_part_numbers.update","products.customer_part_numbers.delete","product_sds.update","product_documents.create","customer_documents.create","supplier_documents.create","purchase_order_documents.create","product_families.create","product_families.update","cost_book_entries.create","current_cost_sources.put","customers.archive","customers.unarchive","suppliers.archive","suppliers.unarchive","contacts.archive","contacts.unarchive","customer_addresses.archive","customer_addresses.unarchive","supplier_ship_from_locations.archive","supplier_ship_from_locations.unarchive","representatives.create","representatives.update","representatives.archive","representatives.unarchive","payment_terms.create","payment_terms.update","ledger_accounts.create","ledger_accounts.update"]},"status":{"type":"string","enum":["ready","blocked"]},"wouldWrite":{"type":"boolean","enum":[false]},"submit":{"type":"object","properties":{"method":{"type":"string","enum":["POST","PATCH","PUT","DELETE"]},"path":{"type":"string"},"query":{"type":"object","properties":{},"additionalProperties":false}},"required":["method","path","query"],"additionalProperties":false},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false},"checks":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["not_direct_ship","address_role_required","address_role_valid","already_assigned","already_exists","active_duplicate","ambiguous_external_id","ambiguous_natural_key","api_created","archived_target","archived_record","archive_blocked","account_type_locked","duplicate_candidate_found","duplicate_candidate_overflow","duplicate_check_clear","duplicate_check_not_needed","duplicate_contact","duplicate_customer","duplicate_customer_address","duplicate_customer_location","duplicate_note","duplicate_resolution_applied","duplicate_supplier","duplicate_supplier_ship_from_location","document_url_org_scoped","document_url_valid","upload_verified","sds_converged","idempotency_available","idempotency_key_required","idempotency_key_reused","idempotency_replay","idempotency_target_missing","income_statement_type_invalid","hard_identity_clear","nested_external_id_clear","commercial_references_valid","credit_denomination_mismatch","customer_service_representative_reference_active","ledger_account_reference_valid","payment_terms_reference_exists","sales_person_reference_active","supplier_representative_reference_active","duplicate_reference_identity","external_id_conflict","if_match_current","base_uom_transition_allowed","base_uom_transition_blocked","attribute_assignments_valid","attribute_assignments_invalid","selected_supplier_link","linked_records_available","natural_key_conflict","not_api_created","no_downstream_mutation","order_sensitive_update_allowed","order_sensitive_update_blocked","parent_available","cost_book_entry_blocked","cost_book_entry_valid","cost_book_reference_not_visible","unsupported_cost_book_uom","cost_uom_conversion_unavailable","cost_book_base_unavailable","cost_book_base_ambiguous","cost_ship_from_location_not_visible","cost_package_quantity_invalid","cost_component_invalid","cost_date_window_invalid","cost_date_overlap","cost_amount_overflow","cost_book_conflict","product_family_reference_active","product_packaging_reference_active","primary_child_available","primary_change_unsupported","reference_visibility_blocked","scope_authorized","stale_record","stale_cost_book_entry","supplier_reference_active","tag_applicable","tag_available","tag_exists","tag_found","tag_not_applicable","tag_not_found","type_immutable","type_known","type_required","target_active","target_available","target_not_found_or_not_visible","targets_visible","unsupported_linked_record","unsupported_profile_shape","variable_qty_valid","validation_failed","value_nonempty"]},"status":{"type":"string","enum":["passed","blocked"]},"message":{"type":"string"},"param":{"type":"string"}},"required":["code","status","message"],"additionalProperties":false}},"duplicateCandidates":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact","customer","supplier","customer_location","customer_address","supplier_ship_from_location","product","product_family","document"]},"readable":{"type":"boolean"},"version":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","product","purchase_order"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"matchReasons":{"type":"array","items":{"type":"string","enum":["name","email","externalId","address","code","product","url"]}},"readbackPath":{"type":"string"}},"required":["type","readable","matchReasons"],"additionalProperties":false}},"idempotency":{"type":"object","properties":{"required":{"type":"boolean"},"keyProvided":{"type":"boolean"},"wouldReplay":{"type":"boolean"}},"required":["required","keyProvided","wouldReplay"],"additionalProperties":false},"wouldChange":{"type":"object","properties":{"fieldNames":{"type":"array","items":{"type":"string"}},"values":{"type":"object","additionalProperties":{}}},"required":["fieldNames","values"],"additionalProperties":false},"impactAnalysis":{"type":"object","additionalProperties":{}},"requestId":{"type":"string"}},"required":["type","operation","status","wouldWrite","submit","verification","checks","duplicateCandidates","requestId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}]}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested parent or record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"409":{"description":"The write conflicted with an existing record, idempotency payload, or stale If-Match value.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/customers/{id}/documents":{"get":{"operationId":"listPublicAPICustomerDocuments","summary":"List customer documents","description":"Returns attached documents on one visible customer, omitting dismissed rows. Document files are user-attached files and may contain sensitive commercial or tax data; ShelfCycle bucket files are returned as 15-minute signed read URLs.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":["customers:read","search:read"],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Customer attached documents.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"documents":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["document"]},"id":{"type":"string","format":"uuid"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"urlClass":{"type":"string","enum":["shelfcycle","external"]},"access":{"type":"object","properties":{"mode":{"type":"string","enum":["signed","raw","unavailable"]},"url":{"type":"string"},"expiresAt":{"type":"string","format":"date-time"}},"required":["mode"],"additionalProperties":false}},"required":["type","id","fileName","createdAt","urlClass","access"],"additionalProperties":false}},"truncated":{"type":"boolean"}},"required":["documents","truncated"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}},"post":{"operationId":"createPublicAPICustomerDocument","summary":"Attach a customer document","description":"Creates an attached document on a visible active customer. Execute requests require Idempotency-Key. dryRun=true may omit Idempotency-Key and returns a blocked readiness check instead of writing. The body may be an existing external/legacy link or data.document from the upload-grant route. New API-upload descriptors are HEAD-verified only after replay and duplicate checks. This creates one Document row and one idempotency identity only. It does not transport binary files through the application, mutate the customer, delete documents, or touch tax, payment, ledger, order, inventory, or accounting records. A valid API-upload descriptor may be passed between keys in the same organization. documents:upload is required only to mint the grant; association and SDS routes require their documented target write scope and current ShelfCycle access. Descriptor possession grants no read access. API-upload association create and replay responses omit signed access unless the calling key also has the target read scope and live view permission.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"customers:write","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","enum":["true"]},"required":false,"name":"dryRun","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Required for execute requests. dryRun=true may omit this header and receive an idempotency_key_required check."},"required":false,"description":"Required for execute requests. dryRun=true may omit this header and receive an idempotency_key_required check.","name":"Idempotency-Key","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"fileName":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[^\\u0000-\\u001F\\u007F]*$"},"url":{"type":"string","minLength":1,"maxLength":2048}},"required":["fileName","url"],"additionalProperties":false}}}},"responses":{"200":{"description":"Idempotent replay returned the existing customer document, or dryRun returned write readiness.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["document"]},"id":{"type":"string","format":"uuid"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"urlClass":{"type":"string","enum":["shelfcycle","external"]},"access":{"type":"object","properties":{"mode":{"type":"string","enum":["signed","raw","unavailable"]},"url":{"type":"string"},"expiresAt":{"type":"string","format":"date-time"}},"required":["mode"],"additionalProperties":false},"idempotencyStatus":{"type":"string","enum":["created","replayed"]},"integrity":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","enum":["verified"]},"checksumSha256":{"type":"string","pattern":"^[a-f0-9]{64}$","description":"Lowercase SHA-256 matched by the association-time storage HEAD check."},"sizeBytes":{"type":"integer","exclusiveMinimum":0,"description":"Storage-reported object size verified at association time."},"contentType":{"type":"string","minLength":1,"description":"Storage-reported canonical content type verified at association time."},"verifiedAt":{"type":"string","format":"date-time","description":"Time ShelfCycle completed the association verification."}},"required":["status","checksumSha256","sizeBytes","contentType","verifiedAt"],"additionalProperties":false,"description":"Durable association receipt; it is not malware scanning, content interpretation, or perpetual-retention proof."},{"type":"object","properties":{"status":{"type":"string","enum":["not_verified"]},"reason":{"type":"string","enum":["external_or_legacy_link"]}},"required":["status","reason"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","enum":["unavailable"]},"reason":{"type":"string","enum":["legacy_receipt_not_recorded"]}},"required":["status","reason"],"additionalProperties":false}]}},"required":["type","id","fileName","createdAt","urlClass","access","idempotencyStatus","integrity"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["write_readiness"]},"operation":{"type":"string","enum":["warehouses.create","warehouses.update","warehouses.archive","warehouses.unarchive","shipping_options.create","shipping_options.update","shipping_options.archive","shipping_options.unarchive","reorder_points.create","tags.create","tags.update","tag_assignments.create","tag_assignments.delete","notes.create","notes.update","opportunities.create","opportunities.update","opportunities.close","opportunities.meta-upsert","contacts.create","contacts.update","customers.create","customers.update","customer_locations.create","customer_locations.update","customer_addresses.create","customer_addresses.update","suppliers.create","suppliers.update","supplier_ship_from_locations.create","supplier_ship_from_locations.update","products.create","products.update","products.archive","products.unarchive","product_packaging.create","products.suppliers.create","products.suppliers.delete","products.aliases.create","products.aliases.update","products.aliases.delete","product_families.aliases.create","product_families.aliases.update","product_families.aliases.delete","products.customer_part_numbers.create","products.customer_part_numbers.update","products.customer_part_numbers.delete","product_sds.update","product_documents.create","customer_documents.create","supplier_documents.create","purchase_order_documents.create","product_families.create","product_families.update","cost_book_entries.create","current_cost_sources.put","customers.archive","customers.unarchive","suppliers.archive","suppliers.unarchive","contacts.archive","contacts.unarchive","customer_addresses.archive","customer_addresses.unarchive","supplier_ship_from_locations.archive","supplier_ship_from_locations.unarchive","representatives.create","representatives.update","representatives.archive","representatives.unarchive","payment_terms.create","payment_terms.update","ledger_accounts.create","ledger_accounts.update"]},"status":{"type":"string","enum":["ready","blocked"]},"wouldWrite":{"type":"boolean","enum":[false]},"submit":{"type":"object","properties":{"method":{"type":"string","enum":["POST","PATCH","PUT","DELETE"]},"path":{"type":"string"},"query":{"type":"object","properties":{},"additionalProperties":false}},"required":["method","path","query"],"additionalProperties":false},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false},"checks":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["not_direct_ship","address_role_required","address_role_valid","already_assigned","already_exists","active_duplicate","ambiguous_external_id","ambiguous_natural_key","api_created","archived_target","archived_record","archive_blocked","account_type_locked","duplicate_candidate_found","duplicate_candidate_overflow","duplicate_check_clear","duplicate_check_not_needed","duplicate_contact","duplicate_customer","duplicate_customer_address","duplicate_customer_location","duplicate_note","duplicate_resolution_applied","duplicate_supplier","duplicate_supplier_ship_from_location","document_url_org_scoped","document_url_valid","upload_verified","sds_converged","idempotency_available","idempotency_key_required","idempotency_key_reused","idempotency_replay","idempotency_target_missing","income_statement_type_invalid","hard_identity_clear","nested_external_id_clear","commercial_references_valid","credit_denomination_mismatch","customer_service_representative_reference_active","ledger_account_reference_valid","payment_terms_reference_exists","sales_person_reference_active","supplier_representative_reference_active","duplicate_reference_identity","external_id_conflict","if_match_current","base_uom_transition_allowed","base_uom_transition_blocked","attribute_assignments_valid","attribute_assignments_invalid","selected_supplier_link","linked_records_available","natural_key_conflict","not_api_created","no_downstream_mutation","order_sensitive_update_allowed","order_sensitive_update_blocked","parent_available","cost_book_entry_blocked","cost_book_entry_valid","cost_book_reference_not_visible","unsupported_cost_book_uom","cost_uom_conversion_unavailable","cost_book_base_unavailable","cost_book_base_ambiguous","cost_ship_from_location_not_visible","cost_package_quantity_invalid","cost_component_invalid","cost_date_window_invalid","cost_date_overlap","cost_amount_overflow","cost_book_conflict","product_family_reference_active","product_packaging_reference_active","primary_child_available","primary_change_unsupported","reference_visibility_blocked","scope_authorized","stale_record","stale_cost_book_entry","supplier_reference_active","tag_applicable","tag_available","tag_exists","tag_found","tag_not_applicable","tag_not_found","type_immutable","type_known","type_required","target_active","target_available","target_not_found_or_not_visible","targets_visible","unsupported_linked_record","unsupported_profile_shape","variable_qty_valid","validation_failed","value_nonempty"]},"status":{"type":"string","enum":["passed","blocked"]},"message":{"type":"string"},"param":{"type":"string"}},"required":["code","status","message"],"additionalProperties":false}},"duplicateCandidates":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact","customer","supplier","customer_location","customer_address","supplier_ship_from_location","product","product_family","document"]},"readable":{"type":"boolean"},"version":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","product","purchase_order"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"matchReasons":{"type":"array","items":{"type":"string","enum":["name","email","externalId","address","code","product","url"]}},"readbackPath":{"type":"string"}},"required":["type","readable","matchReasons"],"additionalProperties":false}},"idempotency":{"type":"object","properties":{"required":{"type":"boolean"},"keyProvided":{"type":"boolean"},"wouldReplay":{"type":"boolean"}},"required":["required","keyProvided","wouldReplay"],"additionalProperties":false},"wouldChange":{"type":"object","properties":{"fieldNames":{"type":"array","items":{"type":"string"}},"values":{"type":"object","additionalProperties":{}}},"required":["fieldNames","values"],"additionalProperties":false},"impactAnalysis":{"type":"object","additionalProperties":{}},"requestId":{"type":"string"}},"required":["type","operation","status","wouldWrite","submit","verification","checks","duplicateCandidates","requestId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}]},"examples":{"verified-api-upload-replay":{"summary":"Exact replay returns the stored association receipt without another storage check","value":{"data":{"type":"document","id":"11111111-1111-4111-8111-111111111111","fileName":"Supplier Confirmation.pdf","createdAt":"2026-08-11T12:00:00.000Z","urlClass":"shelfcycle","access":{"mode":"unavailable"},"idempotencyStatus":"replayed","integrity":{"status":"verified","checksumSha256":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","sizeBytes":4096,"contentType":"application/pdf","verifiedAt":"2026-08-11T12:00:00.000Z"}}}}}}}},"201":{"description":"Customer document created.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["document"]},"id":{"type":"string","format":"uuid"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"urlClass":{"type":"string","enum":["shelfcycle","external"]},"access":{"type":"object","properties":{"mode":{"type":"string","enum":["signed","raw","unavailable"]},"url":{"type":"string"},"expiresAt":{"type":"string","format":"date-time"}},"required":["mode"],"additionalProperties":false},"idempotencyStatus":{"type":"string","enum":["created","replayed"]},"integrity":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","enum":["verified"]},"checksumSha256":{"type":"string","pattern":"^[a-f0-9]{64}$","description":"Lowercase SHA-256 matched by the association-time storage HEAD check."},"sizeBytes":{"type":"integer","exclusiveMinimum":0,"description":"Storage-reported object size verified at association time."},"contentType":{"type":"string","minLength":1,"description":"Storage-reported canonical content type verified at association time."},"verifiedAt":{"type":"string","format":"date-time","description":"Time ShelfCycle completed the association verification."}},"required":["status","checksumSha256","sizeBytes","contentType","verifiedAt"],"additionalProperties":false,"description":"Durable association receipt; it is not malware scanning, content interpretation, or perpetual-retention proof."},{"type":"object","properties":{"status":{"type":"string","enum":["not_verified"]},"reason":{"type":"string","enum":["external_or_legacy_link"]}},"required":["status","reason"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","enum":["unavailable"]},"reason":{"type":"string","enum":["legacy_receipt_not_recorded"]}},"required":["status","reason"],"additionalProperties":false}]}},"required":["type","id","fileName","createdAt","urlClass","access","idempotencyStatus","integrity"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},"examples":{"verified-api-upload":{"summary":"API-upload association with a durable integrity receipt","value":{"data":{"type":"document","id":"11111111-1111-4111-8111-111111111111","fileName":"Supplier Confirmation.pdf","createdAt":"2026-08-11T12:00:00.000Z","urlClass":"shelfcycle","access":{"mode":"unavailable"},"idempotencyStatus":"created","integrity":{"status":"verified","checksumSha256":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","sizeBytes":4096,"contentType":"application/pdf","verifiedAt":"2026-08-11T12:00:00.000Z"}}}}}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested parent or record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"409":{"description":"The write conflicted with an existing record, idempotency payload, or stale If-Match value.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/reference/customers":{"get":{"operationId":"listPublicAPICustomerReferences","summary":"Page active customer references","description":"Pages active customer matching hints for local agent caches. This is not a customer detail export, contact export, incremental sync, archived export, or write authorization surface. Clients must fetch exact detail endpoints before writes.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"company-reference:read","parameters":[{"schema":{"type":"string"},"required":false,"name":"limit","in":"query"},{"schema":{"type":"string"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"string","enum":["false"]},"required":false,"name":"includeArchived","in":"query"}],"responses":{"200":{"description":"Active customer reference rows and cursor metadata.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"externalId":{"type":["string","null"]},"alternateNames":{"type":"array","items":{"type":"string"}},"website":{"type":["string","null"]},"emailDomains":{"type":"array","items":{"type":"string"}},"phone":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"country":{"type":["string","null"]},"status":{"type":"string","enum":["active"]},"updatedAt":{"type":"string","format":"date-time"},"url":{"type":"string"},"type":{"type":"string","enum":["customer"]}},"required":["id","displayName","externalId","alternateNames","website","emailDomains","phone","city","state","country","status","updatedAt","url","type"],"additionalProperties":false}},"meta":{"type":"object","properties":{"requestId":{"type":"string"},"mode":{"type":"string","enum":["active_reference_directory"]},"resource":{"type":"string","enum":["customers","suppliers"]},"limit":{"type":"integer"},"hasMore":{"type":"boolean"},"truncated":{"type":"boolean"},"nextCursor":{"type":["string","null"]},"generatedAt":{"type":"string","format":"date-time"},"sort":{"type":"string","enum":["id_asc"]},"filters":{"type":"object","properties":{"includeArchived":{"type":"boolean","enum":[false]}},"required":["includeArchived"],"additionalProperties":false}},"required":["requestId","mode","resource","limit","hasMore","truncated","nextCursor","generatedAt","sort","filters"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/customers/{id}/locations":{"get":{"operationId":"listPublicAPICustomerLocations","summary":"List customer locations","description":"Pages active customer locations under one visible active customer. This is parent scoped and not a broad location export.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":["customers:read","search:read"],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string"},"required":false,"name":"limit","in":"query"},{"schema":{"type":"string","maxLength":2048},"required":false,"name":"cursor","in":"query"}],"responses":{"200":{"description":"Parent-scoped active customer locations.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["customer_location"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"apiPath":{"type":"string"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"archived":{"type":"boolean"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"name":{"type":"string"},"primary":{"type":"boolean"},"email":{"type":["string","null"]},"website":{"type":["string","null"]},"phone":{"type":["string","null"]},"creditLimit":{"type":"object","properties":{"amountCents":{"type":["integer","null"],"minimum":0,"maximum":2147483647},"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"}},"required":["amountCents","currencyCode"],"additionalProperties":false},"accountOwner":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":["string","null"]},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"}},"required":["id","firstName","lastName","externalId","archivedAt"],"additionalProperties":false},"paymentTerms":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"externalId":{"type":["string","null"]}},"required":["id","name","externalId"],"additionalProperties":false},"customerServiceRepresentative":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":["string","null"]},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"}},"required":["id","firstName","lastName","externalId","archivedAt"],"additionalProperties":false},"accountManager":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]}},"required":["id","firstName","lastName"],"additionalProperties":false},"addresses":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["customer_address"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"apiPath":{"type":"string"},"archived":{"type":"boolean"},"name":{"type":"string"},"street1":{"type":["string","null"]},"street2":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"zip":{"type":["string","null"]},"country":{"type":["string","null"]},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"externalId":{"type":["string","null"]},"isBilling":{"type":"boolean"},"isShipping":{"type":"boolean"},"defaultOrderShippingRemarks":{"type":["string","null"]}},"required":["type","id","displayName","apiPath","archived","name","street1","street2","city","state","zip","country","email","phone","externalId","isBilling","isShipping","defaultOrderShippingRemarks"],"additionalProperties":false}},"addressesTruncated":{"type":"boolean"},"requestedVia":{"type":"object","properties":{"type":{"type":"string","enum":["api_key"]},"id":{"type":"string","format":"uuid"},"purpose":{"type":["string","null"]}},"required":["type","id","purpose"],"additionalProperties":false},"idempotencyStatus":{"type":"string","enum":["created","replayed","updated","fetched"]}},"required":["type","id","displayName","apiPath","parent","archived","createdAt","updatedAt","name","primary","email","website","phone","creditLimit","accountOwner","paymentTerms","customerServiceRepresentative","accountManager","addresses","addressesTruncated","requestedVia","idempotencyStatus"],"additionalProperties":false}},"meta":{"type":"object","properties":{"requestId":{"type":"string"},"mode":{"type":"string","enum":["parent_scoped_child_list"]},"resource":{"type":"string","enum":["customer_locations","customer_addresses","supplier_ship_from_locations"]},"limit":{"type":"integer"},"hasMore":{"type":"boolean"},"truncated":{"type":"boolean"},"nextCursor":{"type":["string","null"]},"generatedAt":{"type":"string","format":"date-time"},"sort":{"type":"string","enum":["id_asc"]},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false}},"required":["requestId","mode","resource","limit","hasMore","truncated","nextCursor","generatedAt","sort","parent"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}},"post":{"operationId":"createPublicAPICustomerLocation","summary":"Create a customer location","description":"Creates an active customer location with its initial billing or shipping address under a visible active customer. Execute requests require Idempotency-Key. dryRun=true may omit Idempotency-Key and returns a blocked readiness check instead of writing.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"customers:write","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","enum":["true"]},"required":false,"name":"dryRun","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Required for execute requests. dryRun=true may omit this header and receive an idempotency_key_required check."},"required":false,"description":"Required for execute requests. dryRun=true may omit this header and receive an idempotency_key_required check.","name":"Idempotency-Key","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":160},"email":{"type":["string","null"],"maxLength":240},"website":{"type":["string","null"],"maxLength":240},"phone":{"type":["string","null"],"maxLength":80},"accountOwnerId":{"type":["string","null"],"format":"uuid"},"paymentTermsId":{"type":["string","null"],"format":"uuid"},"customerServiceRepresentativeId":{"type":["string","null"],"format":"uuid"},"creditLimit":{"type":["object","null"],"properties":{"amountCents":{"type":["integer","null"],"minimum":0,"maximum":2147483647},"currencyCode":{"type":"string","minLength":3,"maxLength":3}},"required":["amountCents"],"additionalProperties":false},"address":{"type":"object","properties":{"street1":{"type":["string","null"],"maxLength":240},"street2":{"type":["string","null"],"maxLength":240},"city":{"type":["string","null"],"maxLength":120},"state":{"type":["string","null"],"maxLength":80},"zip":{"type":["string","null"],"maxLength":40},"country":{"type":["string","null"],"maxLength":80},"name":{"type":"string","minLength":1,"maxLength":160},"externalId":{"type":["string","null"],"maxLength":120},"email":{"type":["string","null"],"maxLength":240},"phone":{"type":["string","null"],"maxLength":80},"isBilling":{"type":"boolean","default":false},"isShipping":{"type":"boolean","default":false},"defaultOrderShippingRemarks":{"type":["string","null"],"maxLength":2000}},"required":["name"],"additionalProperties":false},"duplicateResolution":{"type":"string","enum":["create_distinct"]}},"required":["name","address"],"additionalProperties":false}}}},"responses":{"200":{"description":"Idempotent replay returned the existing customer location, or dryRun returned write readiness.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["customer_location"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"apiPath":{"type":"string"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"archived":{"type":"boolean"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"name":{"type":"string"},"primary":{"type":"boolean"},"email":{"type":["string","null"]},"website":{"type":["string","null"]},"phone":{"type":["string","null"]},"creditLimit":{"type":"object","properties":{"amountCents":{"type":["integer","null"],"minimum":0,"maximum":2147483647},"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"}},"required":["amountCents","currencyCode"],"additionalProperties":false},"accountOwner":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":["string","null"]},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"}},"required":["id","firstName","lastName","externalId","archivedAt"],"additionalProperties":false},"paymentTerms":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"externalId":{"type":["string","null"]}},"required":["id","name","externalId"],"additionalProperties":false},"customerServiceRepresentative":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":["string","null"]},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"}},"required":["id","firstName","lastName","externalId","archivedAt"],"additionalProperties":false},"accountManager":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]}},"required":["id","firstName","lastName"],"additionalProperties":false},"addresses":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["customer_address"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"apiPath":{"type":"string"},"archived":{"type":"boolean"},"name":{"type":"string"},"street1":{"type":["string","null"]},"street2":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"zip":{"type":["string","null"]},"country":{"type":["string","null"]},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"externalId":{"type":["string","null"]},"isBilling":{"type":"boolean"},"isShipping":{"type":"boolean"},"defaultOrderShippingRemarks":{"type":["string","null"]}},"required":["type","id","displayName","apiPath","archived","name","street1","street2","city","state","zip","country","email","phone","externalId","isBilling","isShipping","defaultOrderShippingRemarks"],"additionalProperties":false}},"addressesTruncated":{"type":"boolean"},"requestedVia":{"type":"object","properties":{"type":{"type":"string","enum":["api_key"]},"id":{"type":"string","format":"uuid"},"purpose":{"type":["string","null"]}},"required":["type","id","purpose"],"additionalProperties":false},"idempotencyStatus":{"type":"string","enum":["created","replayed","updated","fetched"]}},"required":["type","id","displayName","apiPath","parent","archived","createdAt","updatedAt","name","primary","email","website","phone","creditLimit","accountOwner","paymentTerms","customerServiceRepresentative","accountManager","addresses","addressesTruncated","requestedVia","idempotencyStatus"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["write_readiness"]},"operation":{"type":"string","enum":["warehouses.create","warehouses.update","warehouses.archive","warehouses.unarchive","shipping_options.create","shipping_options.update","shipping_options.archive","shipping_options.unarchive","reorder_points.create","tags.create","tags.update","tag_assignments.create","tag_assignments.delete","notes.create","notes.update","opportunities.create","opportunities.update","opportunities.close","opportunities.meta-upsert","contacts.create","contacts.update","customers.create","customers.update","customer_locations.create","customer_locations.update","customer_addresses.create","customer_addresses.update","suppliers.create","suppliers.update","supplier_ship_from_locations.create","supplier_ship_from_locations.update","products.create","products.update","products.archive","products.unarchive","product_packaging.create","products.suppliers.create","products.suppliers.delete","products.aliases.create","products.aliases.update","products.aliases.delete","product_families.aliases.create","product_families.aliases.update","product_families.aliases.delete","products.customer_part_numbers.create","products.customer_part_numbers.update","products.customer_part_numbers.delete","product_sds.update","product_documents.create","customer_documents.create","supplier_documents.create","purchase_order_documents.create","product_families.create","product_families.update","cost_book_entries.create","current_cost_sources.put","customers.archive","customers.unarchive","suppliers.archive","suppliers.unarchive","contacts.archive","contacts.unarchive","customer_addresses.archive","customer_addresses.unarchive","supplier_ship_from_locations.archive","supplier_ship_from_locations.unarchive","representatives.create","representatives.update","representatives.archive","representatives.unarchive","payment_terms.create","payment_terms.update","ledger_accounts.create","ledger_accounts.update"]},"status":{"type":"string","enum":["ready","blocked"]},"wouldWrite":{"type":"boolean","enum":[false]},"submit":{"type":"object","properties":{"method":{"type":"string","enum":["POST","PATCH","PUT","DELETE"]},"path":{"type":"string"},"query":{"type":"object","properties":{},"additionalProperties":false}},"required":["method","path","query"],"additionalProperties":false},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false},"checks":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["not_direct_ship","address_role_required","address_role_valid","already_assigned","already_exists","active_duplicate","ambiguous_external_id","ambiguous_natural_key","api_created","archived_target","archived_record","archive_blocked","account_type_locked","duplicate_candidate_found","duplicate_candidate_overflow","duplicate_check_clear","duplicate_check_not_needed","duplicate_contact","duplicate_customer","duplicate_customer_address","duplicate_customer_location","duplicate_note","duplicate_resolution_applied","duplicate_supplier","duplicate_supplier_ship_from_location","document_url_org_scoped","document_url_valid","upload_verified","sds_converged","idempotency_available","idempotency_key_required","idempotency_key_reused","idempotency_replay","idempotency_target_missing","income_statement_type_invalid","hard_identity_clear","nested_external_id_clear","commercial_references_valid","credit_denomination_mismatch","customer_service_representative_reference_active","ledger_account_reference_valid","payment_terms_reference_exists","sales_person_reference_active","supplier_representative_reference_active","duplicate_reference_identity","external_id_conflict","if_match_current","base_uom_transition_allowed","base_uom_transition_blocked","attribute_assignments_valid","attribute_assignments_invalid","selected_supplier_link","linked_records_available","natural_key_conflict","not_api_created","no_downstream_mutation","order_sensitive_update_allowed","order_sensitive_update_blocked","parent_available","cost_book_entry_blocked","cost_book_entry_valid","cost_book_reference_not_visible","unsupported_cost_book_uom","cost_uom_conversion_unavailable","cost_book_base_unavailable","cost_book_base_ambiguous","cost_ship_from_location_not_visible","cost_package_quantity_invalid","cost_component_invalid","cost_date_window_invalid","cost_date_overlap","cost_amount_overflow","cost_book_conflict","product_family_reference_active","product_packaging_reference_active","primary_child_available","primary_change_unsupported","reference_visibility_blocked","scope_authorized","stale_record","stale_cost_book_entry","supplier_reference_active","tag_applicable","tag_available","tag_exists","tag_found","tag_not_applicable","tag_not_found","type_immutable","type_known","type_required","target_active","target_available","target_not_found_or_not_visible","targets_visible","unsupported_linked_record","unsupported_profile_shape","variable_qty_valid","validation_failed","value_nonempty"]},"status":{"type":"string","enum":["passed","blocked"]},"message":{"type":"string"},"param":{"type":"string"}},"required":["code","status","message"],"additionalProperties":false}},"duplicateCandidates":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact","customer","supplier","customer_location","customer_address","supplier_ship_from_location","product","product_family","document"]},"readable":{"type":"boolean"},"version":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","product","purchase_order"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"matchReasons":{"type":"array","items":{"type":"string","enum":["name","email","externalId","address","code","product","url"]}},"readbackPath":{"type":"string"}},"required":["type","readable","matchReasons"],"additionalProperties":false}},"idempotency":{"type":"object","properties":{"required":{"type":"boolean"},"keyProvided":{"type":"boolean"},"wouldReplay":{"type":"boolean"}},"required":["required","keyProvided","wouldReplay"],"additionalProperties":false},"wouldChange":{"type":"object","properties":{"fieldNames":{"type":"array","items":{"type":"string"}},"values":{"type":"object","additionalProperties":{}}},"required":["fieldNames","values"],"additionalProperties":false},"impactAnalysis":{"type":"object","additionalProperties":{}},"requestId":{"type":"string"}},"required":["type","operation","status","wouldWrite","submit","verification","checks","duplicateCandidates","requestId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}]}}}},"201":{"description":"Customer location created.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["customer_location"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"apiPath":{"type":"string"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"archived":{"type":"boolean"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"name":{"type":"string"},"primary":{"type":"boolean"},"email":{"type":["string","null"]},"website":{"type":["string","null"]},"phone":{"type":["string","null"]},"creditLimit":{"type":"object","properties":{"amountCents":{"type":["integer","null"],"minimum":0,"maximum":2147483647},"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"}},"required":["amountCents","currencyCode"],"additionalProperties":false},"accountOwner":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":["string","null"]},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"}},"required":["id","firstName","lastName","externalId","archivedAt"],"additionalProperties":false},"paymentTerms":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"externalId":{"type":["string","null"]}},"required":["id","name","externalId"],"additionalProperties":false},"customerServiceRepresentative":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":["string","null"]},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"}},"required":["id","firstName","lastName","externalId","archivedAt"],"additionalProperties":false},"accountManager":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]}},"required":["id","firstName","lastName"],"additionalProperties":false},"addresses":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["customer_address"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"apiPath":{"type":"string"},"archived":{"type":"boolean"},"name":{"type":"string"},"street1":{"type":["string","null"]},"street2":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"zip":{"type":["string","null"]},"country":{"type":["string","null"]},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"externalId":{"type":["string","null"]},"isBilling":{"type":"boolean"},"isShipping":{"type":"boolean"},"defaultOrderShippingRemarks":{"type":["string","null"]}},"required":["type","id","displayName","apiPath","archived","name","street1","street2","city","state","zip","country","email","phone","externalId","isBilling","isShipping","defaultOrderShippingRemarks"],"additionalProperties":false}},"addressesTruncated":{"type":"boolean"},"requestedVia":{"type":"object","properties":{"type":{"type":"string","enum":["api_key"]},"id":{"type":"string","format":"uuid"},"purpose":{"type":["string","null"]}},"required":["type","id","purpose"],"additionalProperties":false},"idempotencyStatus":{"type":"string","enum":["created","replayed","updated","fetched"]}},"required":["type","id","displayName","apiPath","parent","archived","createdAt","updatedAt","name","primary","email","website","phone","creditLimit","accountOwner","paymentTerms","customerServiceRepresentative","accountManager","addresses","addressesTruncated","requestedVia","idempotencyStatus"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested parent or record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"409":{"description":"The write conflicted with an existing record, idempotency payload, or stale If-Match value.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/customers/{id}/locations/{locationId}":{"get":{"operationId":"getPublicAPICustomerLocation","summary":"Get a customer location","description":"Returns one customer location only when it belongs to the visible customer parent.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":["customers:read","search:read"],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"locationId","in":"path"}],"responses":{"200":{"description":"Customer location detail.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["customer_location"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"apiPath":{"type":"string"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"archived":{"type":"boolean"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"name":{"type":"string"},"primary":{"type":"boolean"},"email":{"type":["string","null"]},"website":{"type":["string","null"]},"phone":{"type":["string","null"]},"creditLimit":{"type":"object","properties":{"amountCents":{"type":["integer","null"],"minimum":0,"maximum":2147483647},"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"}},"required":["amountCents","currencyCode"],"additionalProperties":false},"accountOwner":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":["string","null"]},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"}},"required":["id","firstName","lastName","externalId","archivedAt"],"additionalProperties":false},"paymentTerms":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"externalId":{"type":["string","null"]}},"required":["id","name","externalId"],"additionalProperties":false},"customerServiceRepresentative":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":["string","null"]},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"}},"required":["id","firstName","lastName","externalId","archivedAt"],"additionalProperties":false},"accountManager":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]}},"required":["id","firstName","lastName"],"additionalProperties":false},"addresses":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["customer_address"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"apiPath":{"type":"string"},"archived":{"type":"boolean"},"name":{"type":"string"},"street1":{"type":["string","null"]},"street2":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"zip":{"type":["string","null"]},"country":{"type":["string","null"]},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"externalId":{"type":["string","null"]},"isBilling":{"type":"boolean"},"isShipping":{"type":"boolean"},"defaultOrderShippingRemarks":{"type":["string","null"]}},"required":["type","id","displayName","apiPath","archived","name","street1","street2","city","state","zip","country","email","phone","externalId","isBilling","isShipping","defaultOrderShippingRemarks"],"additionalProperties":false}},"addressesTruncated":{"type":"boolean"},"requestedVia":{"type":"object","properties":{"type":{"type":"string","enum":["api_key"]},"id":{"type":"string","format":"uuid"},"purpose":{"type":["string","null"]}},"required":["type","id","purpose"],"additionalProperties":false},"idempotencyStatus":{"type":"string","enum":["created","replayed","updated","fetched"]}},"required":["type","id","displayName","apiPath","parent","archived","createdAt","updatedAt","name","primary","email","website","phone","creditLimit","accountOwner","paymentTerms","customerServiceRepresentative","accountManager","addresses","addressesTruncated","requestedVia","idempotencyStatus"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updatePublicAPICustomerLocation","summary":"Update a customer location","description":"Updates safe customer location fields. Primary switching is intentionally unsupported. Execute requests require If-Match. dryRun=true may omit If-Match and returns a blocked readiness check instead of writing.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"customers:write","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"locationId","in":"path"},{"schema":{"type":"string","enum":["true"]},"required":false,"name":"dryRun","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check."},"required":false,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check.","name":"If-Match","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":160},"email":{"type":["string","null"],"maxLength":240},"website":{"type":["string","null"],"maxLength":240},"phone":{"type":["string","null"],"maxLength":80},"accountOwnerId":{"type":["string","null"],"format":"uuid"},"paymentTermsId":{"type":["string","null"],"format":"uuid"},"customerServiceRepresentativeId":{"type":["string","null"],"format":"uuid"},"creditLimit":{"type":["object","null"],"properties":{"amountCents":{"type":["integer","null"],"minimum":0,"maximum":2147483647},"currencyCode":{"type":"string","minLength":3,"maxLength":3}},"required":["amountCents"],"additionalProperties":false},"primary":{"type":"boolean"},"makePrimary":{"type":"boolean"}},"additionalProperties":false}}}},"responses":{"200":{"description":"Updated customer location, or dryRun returned write readiness.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["customer_location"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"apiPath":{"type":"string"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"archived":{"type":"boolean"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"name":{"type":"string"},"primary":{"type":"boolean"},"email":{"type":["string","null"]},"website":{"type":["string","null"]},"phone":{"type":["string","null"]},"creditLimit":{"type":"object","properties":{"amountCents":{"type":["integer","null"],"minimum":0,"maximum":2147483647},"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"}},"required":["amountCents","currencyCode"],"additionalProperties":false},"accountOwner":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":["string","null"]},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"}},"required":["id","firstName","lastName","externalId","archivedAt"],"additionalProperties":false},"paymentTerms":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"externalId":{"type":["string","null"]}},"required":["id","name","externalId"],"additionalProperties":false},"customerServiceRepresentative":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":["string","null"]},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"}},"required":["id","firstName","lastName","externalId","archivedAt"],"additionalProperties":false},"accountManager":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]}},"required":["id","firstName","lastName"],"additionalProperties":false},"addresses":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["customer_address"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"apiPath":{"type":"string"},"archived":{"type":"boolean"},"name":{"type":"string"},"street1":{"type":["string","null"]},"street2":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"zip":{"type":["string","null"]},"country":{"type":["string","null"]},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"externalId":{"type":["string","null"]},"isBilling":{"type":"boolean"},"isShipping":{"type":"boolean"},"defaultOrderShippingRemarks":{"type":["string","null"]}},"required":["type","id","displayName","apiPath","archived","name","street1","street2","city","state","zip","country","email","phone","externalId","isBilling","isShipping","defaultOrderShippingRemarks"],"additionalProperties":false}},"addressesTruncated":{"type":"boolean"},"requestedVia":{"type":"object","properties":{"type":{"type":"string","enum":["api_key"]},"id":{"type":"string","format":"uuid"},"purpose":{"type":["string","null"]}},"required":["type","id","purpose"],"additionalProperties":false},"idempotencyStatus":{"type":"string","enum":["created","replayed","updated","fetched"]}},"required":["type","id","displayName","apiPath","parent","archived","createdAt","updatedAt","name","primary","email","website","phone","creditLimit","accountOwner","paymentTerms","customerServiceRepresentative","accountManager","addresses","addressesTruncated","requestedVia","idempotencyStatus"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["write_readiness"]},"operation":{"type":"string","enum":["warehouses.create","warehouses.update","warehouses.archive","warehouses.unarchive","shipping_options.create","shipping_options.update","shipping_options.archive","shipping_options.unarchive","reorder_points.create","tags.create","tags.update","tag_assignments.create","tag_assignments.delete","notes.create","notes.update","opportunities.create","opportunities.update","opportunities.close","opportunities.meta-upsert","contacts.create","contacts.update","customers.create","customers.update","customer_locations.create","customer_locations.update","customer_addresses.create","customer_addresses.update","suppliers.create","suppliers.update","supplier_ship_from_locations.create","supplier_ship_from_locations.update","products.create","products.update","products.archive","products.unarchive","product_packaging.create","products.suppliers.create","products.suppliers.delete","products.aliases.create","products.aliases.update","products.aliases.delete","product_families.aliases.create","product_families.aliases.update","product_families.aliases.delete","products.customer_part_numbers.create","products.customer_part_numbers.update","products.customer_part_numbers.delete","product_sds.update","product_documents.create","customer_documents.create","supplier_documents.create","purchase_order_documents.create","product_families.create","product_families.update","cost_book_entries.create","current_cost_sources.put","customers.archive","customers.unarchive","suppliers.archive","suppliers.unarchive","contacts.archive","contacts.unarchive","customer_addresses.archive","customer_addresses.unarchive","supplier_ship_from_locations.archive","supplier_ship_from_locations.unarchive","representatives.create","representatives.update","representatives.archive","representatives.unarchive","payment_terms.create","payment_terms.update","ledger_accounts.create","ledger_accounts.update"]},"status":{"type":"string","enum":["ready","blocked"]},"wouldWrite":{"type":"boolean","enum":[false]},"submit":{"type":"object","properties":{"method":{"type":"string","enum":["POST","PATCH","PUT","DELETE"]},"path":{"type":"string"},"query":{"type":"object","properties":{},"additionalProperties":false}},"required":["method","path","query"],"additionalProperties":false},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false},"checks":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["not_direct_ship","address_role_required","address_role_valid","already_assigned","already_exists","active_duplicate","ambiguous_external_id","ambiguous_natural_key","api_created","archived_target","archived_record","archive_blocked","account_type_locked","duplicate_candidate_found","duplicate_candidate_overflow","duplicate_check_clear","duplicate_check_not_needed","duplicate_contact","duplicate_customer","duplicate_customer_address","duplicate_customer_location","duplicate_note","duplicate_resolution_applied","duplicate_supplier","duplicate_supplier_ship_from_location","document_url_org_scoped","document_url_valid","upload_verified","sds_converged","idempotency_available","idempotency_key_required","idempotency_key_reused","idempotency_replay","idempotency_target_missing","income_statement_type_invalid","hard_identity_clear","nested_external_id_clear","commercial_references_valid","credit_denomination_mismatch","customer_service_representative_reference_active","ledger_account_reference_valid","payment_terms_reference_exists","sales_person_reference_active","supplier_representative_reference_active","duplicate_reference_identity","external_id_conflict","if_match_current","base_uom_transition_allowed","base_uom_transition_blocked","attribute_assignments_valid","attribute_assignments_invalid","selected_supplier_link","linked_records_available","natural_key_conflict","not_api_created","no_downstream_mutation","order_sensitive_update_allowed","order_sensitive_update_blocked","parent_available","cost_book_entry_blocked","cost_book_entry_valid","cost_book_reference_not_visible","unsupported_cost_book_uom","cost_uom_conversion_unavailable","cost_book_base_unavailable","cost_book_base_ambiguous","cost_ship_from_location_not_visible","cost_package_quantity_invalid","cost_component_invalid","cost_date_window_invalid","cost_date_overlap","cost_amount_overflow","cost_book_conflict","product_family_reference_active","product_packaging_reference_active","primary_child_available","primary_change_unsupported","reference_visibility_blocked","scope_authorized","stale_record","stale_cost_book_entry","supplier_reference_active","tag_applicable","tag_available","tag_exists","tag_found","tag_not_applicable","tag_not_found","type_immutable","type_known","type_required","target_active","target_available","target_not_found_or_not_visible","targets_visible","unsupported_linked_record","unsupported_profile_shape","variable_qty_valid","validation_failed","value_nonempty"]},"status":{"type":"string","enum":["passed","blocked"]},"message":{"type":"string"},"param":{"type":"string"}},"required":["code","status","message"],"additionalProperties":false}},"duplicateCandidates":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact","customer","supplier","customer_location","customer_address","supplier_ship_from_location","product","product_family","document"]},"readable":{"type":"boolean"},"version":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","product","purchase_order"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"matchReasons":{"type":"array","items":{"type":"string","enum":["name","email","externalId","address","code","product","url"]}},"readbackPath":{"type":"string"}},"required":["type","readable","matchReasons"],"additionalProperties":false}},"idempotency":{"type":"object","properties":{"required":{"type":"boolean"},"keyProvided":{"type":"boolean"},"wouldReplay":{"type":"boolean"}},"required":["required","keyProvided","wouldReplay"],"additionalProperties":false},"wouldChange":{"type":"object","properties":{"fieldNames":{"type":"array","items":{"type":"string"}},"values":{"type":"object","additionalProperties":{}}},"required":["fieldNames","values"],"additionalProperties":false},"impactAnalysis":{"type":"object","additionalProperties":{}},"requestId":{"type":"string"}},"required":["type","operation","status","wouldWrite","submit","verification","checks","duplicateCandidates","requestId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}]}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested parent or record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"409":{"description":"The write conflicted with an existing record, idempotency payload, or stale If-Match value.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/customers/{id}/locations/{locationId}/addresses":{"get":{"operationId":"listPublicAPICustomerAddresses","summary":"List customer location addresses","description":"Pages active customer addresses under one visible active customer location. This is parent scoped and not a broad address export.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":["customers:read","search:read"],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"locationId","in":"path"},{"schema":{"type":"string"},"required":false,"name":"limit","in":"query"},{"schema":{"type":"string","maxLength":2048},"required":false,"name":"cursor","in":"query"}],"responses":{"200":{"description":"Parent-scoped active customer addresses.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["customer_address"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"apiPath":{"type":"string"},"archived":{"type":"boolean"},"name":{"type":"string"},"street1":{"type":["string","null"]},"street2":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"zip":{"type":["string","null"]},"country":{"type":["string","null"]},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"externalId":{"type":["string","null"]},"isBilling":{"type":"boolean"},"isShipping":{"type":"boolean"},"defaultOrderShippingRemarks":{"type":["string","null"]},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"location":{"type":"object","properties":{"type":{"type":"string","enum":["customer_location"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"primary":{"type":"boolean"},"archived":{"type":"boolean"}},"required":["type","id","displayName","primary","archived"],"additionalProperties":false},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"requestedVia":{"type":"object","properties":{"type":{"type":"string","enum":["api_key"]},"id":{"type":"string","format":"uuid"},"purpose":{"type":["string","null"]}},"required":["type","id","purpose"],"additionalProperties":false},"idempotencyStatus":{"type":"string","enum":["created","replayed","updated","fetched"]}},"required":["type","id","displayName","apiPath","archived","name","street1","street2","city","state","zip","country","email","phone","externalId","isBilling","isShipping","defaultOrderShippingRemarks","parent","location","createdAt","updatedAt","requestedVia","idempotencyStatus"],"additionalProperties":false}},"meta":{"type":"object","properties":{"requestId":{"type":"string"},"mode":{"type":"string","enum":["parent_scoped_child_list"]},"resource":{"type":"string","enum":["customer_locations","customer_addresses","supplier_ship_from_locations"]},"limit":{"type":"integer"},"hasMore":{"type":"boolean"},"truncated":{"type":"boolean"},"nextCursor":{"type":["string","null"]},"generatedAt":{"type":"string","format":"date-time"},"sort":{"type":"string","enum":["id_asc"]},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false}},"required":["requestId","mode","resource","limit","hasMore","truncated","nextCursor","generatedAt","sort","parent"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}},"post":{"operationId":"createPublicAPICustomerAddress","summary":"Create a customer address","description":"Creates a billing or shipping address under a visible active customer location. Execute requests require Idempotency-Key. dryRun=true may omit Idempotency-Key and returns a blocked readiness check instead of writing.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"customers:write","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"locationId","in":"path"},{"schema":{"type":"string","enum":["true"]},"required":false,"name":"dryRun","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Required for execute requests. dryRun=true may omit this header and receive an idempotency_key_required check."},"required":false,"description":"Required for execute requests. dryRun=true may omit this header and receive an idempotency_key_required check.","name":"Idempotency-Key","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"street1":{"type":["string","null"],"maxLength":240},"street2":{"type":["string","null"],"maxLength":240},"city":{"type":["string","null"],"maxLength":120},"state":{"type":["string","null"],"maxLength":80},"zip":{"type":["string","null"],"maxLength":40},"country":{"type":["string","null"],"maxLength":80},"name":{"type":"string","minLength":1,"maxLength":160},"externalId":{"type":["string","null"],"maxLength":120},"email":{"type":["string","null"],"maxLength":240},"phone":{"type":["string","null"],"maxLength":80},"isBilling":{"type":"boolean","default":false},"isShipping":{"type":"boolean","default":false},"defaultOrderShippingRemarks":{"type":["string","null"],"maxLength":2000},"duplicateResolution":{"type":"string","enum":["create_distinct"]}},"required":["name"],"additionalProperties":false}}}},"responses":{"200":{"description":"Idempotent replay returned the existing customer address, or dryRun returned write readiness.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["customer_address"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"apiPath":{"type":"string"},"archived":{"type":"boolean"},"name":{"type":"string"},"street1":{"type":["string","null"]},"street2":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"zip":{"type":["string","null"]},"country":{"type":["string","null"]},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"externalId":{"type":["string","null"]},"isBilling":{"type":"boolean"},"isShipping":{"type":"boolean"},"defaultOrderShippingRemarks":{"type":["string","null"]},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"location":{"type":"object","properties":{"type":{"type":"string","enum":["customer_location"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"primary":{"type":"boolean"},"archived":{"type":"boolean"}},"required":["type","id","displayName","primary","archived"],"additionalProperties":false},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"requestedVia":{"type":"object","properties":{"type":{"type":"string","enum":["api_key"]},"id":{"type":"string","format":"uuid"},"purpose":{"type":["string","null"]}},"required":["type","id","purpose"],"additionalProperties":false},"idempotencyStatus":{"type":"string","enum":["created","replayed","updated","fetched"]}},"required":["type","id","displayName","apiPath","archived","name","street1","street2","city","state","zip","country","email","phone","externalId","isBilling","isShipping","defaultOrderShippingRemarks","parent","location","createdAt","updatedAt","requestedVia","idempotencyStatus"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["write_readiness"]},"operation":{"type":"string","enum":["warehouses.create","warehouses.update","warehouses.archive","warehouses.unarchive","shipping_options.create","shipping_options.update","shipping_options.archive","shipping_options.unarchive","reorder_points.create","tags.create","tags.update","tag_assignments.create","tag_assignments.delete","notes.create","notes.update","opportunities.create","opportunities.update","opportunities.close","opportunities.meta-upsert","contacts.create","contacts.update","customers.create","customers.update","customer_locations.create","customer_locations.update","customer_addresses.create","customer_addresses.update","suppliers.create","suppliers.update","supplier_ship_from_locations.create","supplier_ship_from_locations.update","products.create","products.update","products.archive","products.unarchive","product_packaging.create","products.suppliers.create","products.suppliers.delete","products.aliases.create","products.aliases.update","products.aliases.delete","product_families.aliases.create","product_families.aliases.update","product_families.aliases.delete","products.customer_part_numbers.create","products.customer_part_numbers.update","products.customer_part_numbers.delete","product_sds.update","product_documents.create","customer_documents.create","supplier_documents.create","purchase_order_documents.create","product_families.create","product_families.update","cost_book_entries.create","current_cost_sources.put","customers.archive","customers.unarchive","suppliers.archive","suppliers.unarchive","contacts.archive","contacts.unarchive","customer_addresses.archive","customer_addresses.unarchive","supplier_ship_from_locations.archive","supplier_ship_from_locations.unarchive","representatives.create","representatives.update","representatives.archive","representatives.unarchive","payment_terms.create","payment_terms.update","ledger_accounts.create","ledger_accounts.update"]},"status":{"type":"string","enum":["ready","blocked"]},"wouldWrite":{"type":"boolean","enum":[false]},"submit":{"type":"object","properties":{"method":{"type":"string","enum":["POST","PATCH","PUT","DELETE"]},"path":{"type":"string"},"query":{"type":"object","properties":{},"additionalProperties":false}},"required":["method","path","query"],"additionalProperties":false},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false},"checks":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["not_direct_ship","address_role_required","address_role_valid","already_assigned","already_exists","active_duplicate","ambiguous_external_id","ambiguous_natural_key","api_created","archived_target","archived_record","archive_blocked","account_type_locked","duplicate_candidate_found","duplicate_candidate_overflow","duplicate_check_clear","duplicate_check_not_needed","duplicate_contact","duplicate_customer","duplicate_customer_address","duplicate_customer_location","duplicate_note","duplicate_resolution_applied","duplicate_supplier","duplicate_supplier_ship_from_location","document_url_org_scoped","document_url_valid","upload_verified","sds_converged","idempotency_available","idempotency_key_required","idempotency_key_reused","idempotency_replay","idempotency_target_missing","income_statement_type_invalid","hard_identity_clear","nested_external_id_clear","commercial_references_valid","credit_denomination_mismatch","customer_service_representative_reference_active","ledger_account_reference_valid","payment_terms_reference_exists","sales_person_reference_active","supplier_representative_reference_active","duplicate_reference_identity","external_id_conflict","if_match_current","base_uom_transition_allowed","base_uom_transition_blocked","attribute_assignments_valid","attribute_assignments_invalid","selected_supplier_link","linked_records_available","natural_key_conflict","not_api_created","no_downstream_mutation","order_sensitive_update_allowed","order_sensitive_update_blocked","parent_available","cost_book_entry_blocked","cost_book_entry_valid","cost_book_reference_not_visible","unsupported_cost_book_uom","cost_uom_conversion_unavailable","cost_book_base_unavailable","cost_book_base_ambiguous","cost_ship_from_location_not_visible","cost_package_quantity_invalid","cost_component_invalid","cost_date_window_invalid","cost_date_overlap","cost_amount_overflow","cost_book_conflict","product_family_reference_active","product_packaging_reference_active","primary_child_available","primary_change_unsupported","reference_visibility_blocked","scope_authorized","stale_record","stale_cost_book_entry","supplier_reference_active","tag_applicable","tag_available","tag_exists","tag_found","tag_not_applicable","tag_not_found","type_immutable","type_known","type_required","target_active","target_available","target_not_found_or_not_visible","targets_visible","unsupported_linked_record","unsupported_profile_shape","variable_qty_valid","validation_failed","value_nonempty"]},"status":{"type":"string","enum":["passed","blocked"]},"message":{"type":"string"},"param":{"type":"string"}},"required":["code","status","message"],"additionalProperties":false}},"duplicateCandidates":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact","customer","supplier","customer_location","customer_address","supplier_ship_from_location","product","product_family","document"]},"readable":{"type":"boolean"},"version":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","product","purchase_order"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"matchReasons":{"type":"array","items":{"type":"string","enum":["name","email","externalId","address","code","product","url"]}},"readbackPath":{"type":"string"}},"required":["type","readable","matchReasons"],"additionalProperties":false}},"idempotency":{"type":"object","properties":{"required":{"type":"boolean"},"keyProvided":{"type":"boolean"},"wouldReplay":{"type":"boolean"}},"required":["required","keyProvided","wouldReplay"],"additionalProperties":false},"wouldChange":{"type":"object","properties":{"fieldNames":{"type":"array","items":{"type":"string"}},"values":{"type":"object","additionalProperties":{}}},"required":["fieldNames","values"],"additionalProperties":false},"impactAnalysis":{"type":"object","additionalProperties":{}},"requestId":{"type":"string"}},"required":["type","operation","status","wouldWrite","submit","verification","checks","duplicateCandidates","requestId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}]}}}},"201":{"description":"Customer address created.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["customer_address"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"apiPath":{"type":"string"},"archived":{"type":"boolean"},"name":{"type":"string"},"street1":{"type":["string","null"]},"street2":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"zip":{"type":["string","null"]},"country":{"type":["string","null"]},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"externalId":{"type":["string","null"]},"isBilling":{"type":"boolean"},"isShipping":{"type":"boolean"},"defaultOrderShippingRemarks":{"type":["string","null"]},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"location":{"type":"object","properties":{"type":{"type":"string","enum":["customer_location"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"primary":{"type":"boolean"},"archived":{"type":"boolean"}},"required":["type","id","displayName","primary","archived"],"additionalProperties":false},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"requestedVia":{"type":"object","properties":{"type":{"type":"string","enum":["api_key"]},"id":{"type":"string","format":"uuid"},"purpose":{"type":["string","null"]}},"required":["type","id","purpose"],"additionalProperties":false},"idempotencyStatus":{"type":"string","enum":["created","replayed","updated","fetched"]}},"required":["type","id","displayName","apiPath","archived","name","street1","street2","city","state","zip","country","email","phone","externalId","isBilling","isShipping","defaultOrderShippingRemarks","parent","location","createdAt","updatedAt","requestedVia","idempotencyStatus"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested parent or record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"409":{"description":"The write conflicted with an existing record, idempotency payload, or stale If-Match value.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/customers/{id}/locations/{locationId}/addresses/{addressId}":{"get":{"operationId":"getPublicAPICustomerAddress","summary":"Get a customer address","description":"Returns one customer address only when it belongs to the visible customer and location parents.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":["customers:read","search:read"],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"locationId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"addressId","in":"path"}],"responses":{"200":{"description":"Customer address detail.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["customer_address"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"apiPath":{"type":"string"},"archived":{"type":"boolean"},"name":{"type":"string"},"street1":{"type":["string","null"]},"street2":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"zip":{"type":["string","null"]},"country":{"type":["string","null"]},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"externalId":{"type":["string","null"]},"isBilling":{"type":"boolean"},"isShipping":{"type":"boolean"},"defaultOrderShippingRemarks":{"type":["string","null"]},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"location":{"type":"object","properties":{"type":{"type":"string","enum":["customer_location"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"primary":{"type":"boolean"},"archived":{"type":"boolean"}},"required":["type","id","displayName","primary","archived"],"additionalProperties":false},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"requestedVia":{"type":"object","properties":{"type":{"type":"string","enum":["api_key"]},"id":{"type":"string","format":"uuid"},"purpose":{"type":["string","null"]}},"required":["type","id","purpose"],"additionalProperties":false},"idempotencyStatus":{"type":"string","enum":["created","replayed","updated","fetched"]}},"required":["type","id","displayName","apiPath","archived","name","street1","street2","city","state","zip","country","email","phone","externalId","isBilling","isShipping","defaultOrderShippingRemarks","parent","location","createdAt","updatedAt","requestedVia","idempotencyStatus"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updatePublicAPICustomerAddress","summary":"Update a customer address","description":"Updates safe customer address fields. The address must remain billing or shipping eligible. Execute requests require If-Match. dryRun=true may omit If-Match and returns a blocked readiness check instead of writing.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"customers:write","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"locationId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"addressId","in":"path"},{"schema":{"type":"string","enum":["true"]},"required":false,"name":"dryRun","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check."},"required":false,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check.","name":"If-Match","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"street1":{"type":["string","null"],"maxLength":240},"street2":{"type":["string","null"],"maxLength":240},"city":{"type":["string","null"],"maxLength":120},"state":{"type":["string","null"],"maxLength":80},"zip":{"type":["string","null"],"maxLength":40},"country":{"type":["string","null"],"maxLength":80},"name":{"type":"string","minLength":1,"maxLength":160},"externalId":{"type":["string","null"],"maxLength":120},"email":{"type":["string","null"],"maxLength":240},"phone":{"type":["string","null"],"maxLength":80},"isBilling":{"type":"boolean"},"isShipping":{"type":"boolean"},"defaultOrderShippingRemarks":{"type":["string","null"],"maxLength":2000}},"additionalProperties":false}}}},"responses":{"200":{"description":"Updated customer address, or dryRun returned write readiness.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["customer_address"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"apiPath":{"type":"string"},"archived":{"type":"boolean"},"name":{"type":"string"},"street1":{"type":["string","null"]},"street2":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"zip":{"type":["string","null"]},"country":{"type":["string","null"]},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"externalId":{"type":["string","null"]},"isBilling":{"type":"boolean"},"isShipping":{"type":"boolean"},"defaultOrderShippingRemarks":{"type":["string","null"]},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"location":{"type":"object","properties":{"type":{"type":"string","enum":["customer_location"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"primary":{"type":"boolean"},"archived":{"type":"boolean"}},"required":["type","id","displayName","primary","archived"],"additionalProperties":false},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"requestedVia":{"type":"object","properties":{"type":{"type":"string","enum":["api_key"]},"id":{"type":"string","format":"uuid"},"purpose":{"type":["string","null"]}},"required":["type","id","purpose"],"additionalProperties":false},"idempotencyStatus":{"type":"string","enum":["created","replayed","updated","fetched"]}},"required":["type","id","displayName","apiPath","archived","name","street1","street2","city","state","zip","country","email","phone","externalId","isBilling","isShipping","defaultOrderShippingRemarks","parent","location","createdAt","updatedAt","requestedVia","idempotencyStatus"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["write_readiness"]},"operation":{"type":"string","enum":["warehouses.create","warehouses.update","warehouses.archive","warehouses.unarchive","shipping_options.create","shipping_options.update","shipping_options.archive","shipping_options.unarchive","reorder_points.create","tags.create","tags.update","tag_assignments.create","tag_assignments.delete","notes.create","notes.update","opportunities.create","opportunities.update","opportunities.close","opportunities.meta-upsert","contacts.create","contacts.update","customers.create","customers.update","customer_locations.create","customer_locations.update","customer_addresses.create","customer_addresses.update","suppliers.create","suppliers.update","supplier_ship_from_locations.create","supplier_ship_from_locations.update","products.create","products.update","products.archive","products.unarchive","product_packaging.create","products.suppliers.create","products.suppliers.delete","products.aliases.create","products.aliases.update","products.aliases.delete","product_families.aliases.create","product_families.aliases.update","product_families.aliases.delete","products.customer_part_numbers.create","products.customer_part_numbers.update","products.customer_part_numbers.delete","product_sds.update","product_documents.create","customer_documents.create","supplier_documents.create","purchase_order_documents.create","product_families.create","product_families.update","cost_book_entries.create","current_cost_sources.put","customers.archive","customers.unarchive","suppliers.archive","suppliers.unarchive","contacts.archive","contacts.unarchive","customer_addresses.archive","customer_addresses.unarchive","supplier_ship_from_locations.archive","supplier_ship_from_locations.unarchive","representatives.create","representatives.update","representatives.archive","representatives.unarchive","payment_terms.create","payment_terms.update","ledger_accounts.create","ledger_accounts.update"]},"status":{"type":"string","enum":["ready","blocked"]},"wouldWrite":{"type":"boolean","enum":[false]},"submit":{"type":"object","properties":{"method":{"type":"string","enum":["POST","PATCH","PUT","DELETE"]},"path":{"type":"string"},"query":{"type":"object","properties":{},"additionalProperties":false}},"required":["method","path","query"],"additionalProperties":false},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false},"checks":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["not_direct_ship","address_role_required","address_role_valid","already_assigned","already_exists","active_duplicate","ambiguous_external_id","ambiguous_natural_key","api_created","archived_target","archived_record","archive_blocked","account_type_locked","duplicate_candidate_found","duplicate_candidate_overflow","duplicate_check_clear","duplicate_check_not_needed","duplicate_contact","duplicate_customer","duplicate_customer_address","duplicate_customer_location","duplicate_note","duplicate_resolution_applied","duplicate_supplier","duplicate_supplier_ship_from_location","document_url_org_scoped","document_url_valid","upload_verified","sds_converged","idempotency_available","idempotency_key_required","idempotency_key_reused","idempotency_replay","idempotency_target_missing","income_statement_type_invalid","hard_identity_clear","nested_external_id_clear","commercial_references_valid","credit_denomination_mismatch","customer_service_representative_reference_active","ledger_account_reference_valid","payment_terms_reference_exists","sales_person_reference_active","supplier_representative_reference_active","duplicate_reference_identity","external_id_conflict","if_match_current","base_uom_transition_allowed","base_uom_transition_blocked","attribute_assignments_valid","attribute_assignments_invalid","selected_supplier_link","linked_records_available","natural_key_conflict","not_api_created","no_downstream_mutation","order_sensitive_update_allowed","order_sensitive_update_blocked","parent_available","cost_book_entry_blocked","cost_book_entry_valid","cost_book_reference_not_visible","unsupported_cost_book_uom","cost_uom_conversion_unavailable","cost_book_base_unavailable","cost_book_base_ambiguous","cost_ship_from_location_not_visible","cost_package_quantity_invalid","cost_component_invalid","cost_date_window_invalid","cost_date_overlap","cost_amount_overflow","cost_book_conflict","product_family_reference_active","product_packaging_reference_active","primary_child_available","primary_change_unsupported","reference_visibility_blocked","scope_authorized","stale_record","stale_cost_book_entry","supplier_reference_active","tag_applicable","tag_available","tag_exists","tag_found","tag_not_applicable","tag_not_found","type_immutable","type_known","type_required","target_active","target_available","target_not_found_or_not_visible","targets_visible","unsupported_linked_record","unsupported_profile_shape","variable_qty_valid","validation_failed","value_nonempty"]},"status":{"type":"string","enum":["passed","blocked"]},"message":{"type":"string"},"param":{"type":"string"}},"required":["code","status","message"],"additionalProperties":false}},"duplicateCandidates":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact","customer","supplier","customer_location","customer_address","supplier_ship_from_location","product","product_family","document"]},"readable":{"type":"boolean"},"version":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","product","purchase_order"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"matchReasons":{"type":"array","items":{"type":"string","enum":["name","email","externalId","address","code","product","url"]}},"readbackPath":{"type":"string"}},"required":["type","readable","matchReasons"],"additionalProperties":false}},"idempotency":{"type":"object","properties":{"required":{"type":"boolean"},"keyProvided":{"type":"boolean"},"wouldReplay":{"type":"boolean"}},"required":["required","keyProvided","wouldReplay"],"additionalProperties":false},"wouldChange":{"type":"object","properties":{"fieldNames":{"type":"array","items":{"type":"string"}},"values":{"type":"object","additionalProperties":{}}},"required":["fieldNames","values"],"additionalProperties":false},"impactAnalysis":{"type":"object","additionalProperties":{}},"requestId":{"type":"string"}},"required":["type","operation","status","wouldWrite","submit","verification","checks","duplicateCandidates","requestId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}]}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested parent or record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"409":{"description":"The write conflicted with an existing record, idempotency payload, or stale If-Match value.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/product-families":{"get":{"operationId":"listPublicAPIProductFamilyReferences","summary":"Find product families","description":"Finds existing product family references for product setup. Requires q or exact externalId; this route does not create families.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":["products:read","products:write","search:read"],"parameters":[{"schema":{"type":"string"},"required":false,"name":"q","in":"query"},{"schema":{"type":"string"},"required":false,"name":"externalId","in":"query"},{"schema":{"type":"string"},"required":false,"name":"limit","in":"query"}],"responses":{"200":{"description":"Product family reference summaries.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["product_family"]},"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"externalId":{"type":["string","null"]},"casNumber":{"type":["string","null"]},"molecularFormula":{"type":["string","null"]},"unNumbers":{"type":"array","items":{"type":"string"}},"ghsSignalWord":{"type":["string","null"],"enum":["DANGER","WARNING"]},"hazardSymbols":{"type":"array","items":{"type":"string"}},"updatedAt":{"type":"string","format":"date-time"},"url":{"type":"string"},"idempotencyStatus":{"type":"string","enum":["created","replayed"]}},"required":["type","id","name","externalId","casNumber","molecularFormula","unNumbers","ghsSignalWord","hazardSymbols","updatedAt","url"],"additionalProperties":false}},"meta":{"type":"object","properties":{"requestId":{"type":"string"},"mode":{"type":"string","enum":["product_reference_lookup"]},"resource":{"type":"string","enum":["product_families","product_packaging"]},"limit":{"type":"integer"},"hasMore":{"type":"boolean"},"truncated":{"type":"boolean"},"sort":{"type":"string","enum":["name_asc"]},"filters":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"nextCursor":{"type":["string","null"]}},"required":["requestId","mode","resource","limit","hasMore","truncated","sort","filters"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}},"post":{"operationId":"createPublicAPIProductFamily","summary":"Create a product family","description":"Creates a product family from public-safe identity and regulatory fields. Execute requests require Idempotency-Key. dryRun=true may omit Idempotency-Key and returns a blocked readiness check instead of writing. Product-family writes are bounded by products:write, live ProductPermission.create, duplicate checks, idempotency, and readback verification. They never create products, suppliers, documents, product family attributes, superfund/tax fields, inventory, orders, costs, prices, or accounting records.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"products:write","parameters":[{"schema":{"type":"string","enum":["true"]},"required":false,"name":"dryRun","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Required for execute requests. dryRun=true may omit this header and receive an idempotency_key_required check."},"required":false,"description":"Required for execute requests. dryRun=true may omit this header and receive an idempotency_key_required check.","name":"Idempotency-Key","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":240},"externalId":{"type":["string","null"],"maxLength":120},"casNumber":{"type":["string","null"],"maxLength":80},"molecularFormula":{"type":["string","null"],"maxLength":120},"unNumbers":{"type":"array","items":{"type":"string","minLength":1,"maxLength":20},"default":[]},"ghsSignalWord":{"type":["string","null"],"enum":["DANGER","WARNING"]},"hazardSymbols":{"type":"array","items":{"type":"string","minLength":1,"maxLength":80},"default":[]}},"required":["name"],"additionalProperties":false}}}},"responses":{"200":{"description":"Idempotent replay returned the existing product family, or dryRun returned write readiness.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["product_family"]},"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"externalId":{"type":["string","null"]},"casNumber":{"type":["string","null"]},"molecularFormula":{"type":["string","null"]},"unNumbers":{"type":"array","items":{"type":"string"}},"ghsSignalWord":{"type":["string","null"],"enum":["DANGER","WARNING"]},"hazardSymbols":{"type":"array","items":{"type":"string"}},"updatedAt":{"type":"string","format":"date-time"},"url":{"type":"string"},"idempotencyStatus":{"type":"string","enum":["created","replayed"]}},"required":["type","id","name","externalId","casNumber","molecularFormula","unNumbers","ghsSignalWord","hazardSymbols","updatedAt","url"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["write_readiness"]},"operation":{"type":"string","enum":["warehouses.create","warehouses.update","warehouses.archive","warehouses.unarchive","shipping_options.create","shipping_options.update","shipping_options.archive","shipping_options.unarchive","reorder_points.create","tags.create","tags.update","tag_assignments.create","tag_assignments.delete","notes.create","notes.update","opportunities.create","opportunities.update","opportunities.close","opportunities.meta-upsert","contacts.create","contacts.update","customers.create","customers.update","customer_locations.create","customer_locations.update","customer_addresses.create","customer_addresses.update","suppliers.create","suppliers.update","supplier_ship_from_locations.create","supplier_ship_from_locations.update","products.create","products.update","products.archive","products.unarchive","product_packaging.create","products.suppliers.create","products.suppliers.delete","products.aliases.create","products.aliases.update","products.aliases.delete","product_families.aliases.create","product_families.aliases.update","product_families.aliases.delete","products.customer_part_numbers.create","products.customer_part_numbers.update","products.customer_part_numbers.delete","product_sds.update","product_documents.create","customer_documents.create","supplier_documents.create","purchase_order_documents.create","product_families.create","product_families.update","cost_book_entries.create","current_cost_sources.put","customers.archive","customers.unarchive","suppliers.archive","suppliers.unarchive","contacts.archive","contacts.unarchive","customer_addresses.archive","customer_addresses.unarchive","supplier_ship_from_locations.archive","supplier_ship_from_locations.unarchive","representatives.create","representatives.update","representatives.archive","representatives.unarchive","payment_terms.create","payment_terms.update","ledger_accounts.create","ledger_accounts.update"]},"status":{"type":"string","enum":["ready","blocked"]},"wouldWrite":{"type":"boolean","enum":[false]},"submit":{"type":"object","properties":{"method":{"type":"string","enum":["POST","PATCH","PUT","DELETE"]},"path":{"type":"string"},"query":{"type":"object","properties":{},"additionalProperties":false}},"required":["method","path","query"],"additionalProperties":false},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false},"checks":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["not_direct_ship","address_role_required","address_role_valid","already_assigned","already_exists","active_duplicate","ambiguous_external_id","ambiguous_natural_key","api_created","archived_target","archived_record","archive_blocked","account_type_locked","duplicate_candidate_found","duplicate_candidate_overflow","duplicate_check_clear","duplicate_check_not_needed","duplicate_contact","duplicate_customer","duplicate_customer_address","duplicate_customer_location","duplicate_note","duplicate_resolution_applied","duplicate_supplier","duplicate_supplier_ship_from_location","document_url_org_scoped","document_url_valid","upload_verified","sds_converged","idempotency_available","idempotency_key_required","idempotency_key_reused","idempotency_replay","idempotency_target_missing","income_statement_type_invalid","hard_identity_clear","nested_external_id_clear","commercial_references_valid","credit_denomination_mismatch","customer_service_representative_reference_active","ledger_account_reference_valid","payment_terms_reference_exists","sales_person_reference_active","supplier_representative_reference_active","duplicate_reference_identity","external_id_conflict","if_match_current","base_uom_transition_allowed","base_uom_transition_blocked","attribute_assignments_valid","attribute_assignments_invalid","selected_supplier_link","linked_records_available","natural_key_conflict","not_api_created","no_downstream_mutation","order_sensitive_update_allowed","order_sensitive_update_blocked","parent_available","cost_book_entry_blocked","cost_book_entry_valid","cost_book_reference_not_visible","unsupported_cost_book_uom","cost_uom_conversion_unavailable","cost_book_base_unavailable","cost_book_base_ambiguous","cost_ship_from_location_not_visible","cost_package_quantity_invalid","cost_component_invalid","cost_date_window_invalid","cost_date_overlap","cost_amount_overflow","cost_book_conflict","product_family_reference_active","product_packaging_reference_active","primary_child_available","primary_change_unsupported","reference_visibility_blocked","scope_authorized","stale_record","stale_cost_book_entry","supplier_reference_active","tag_applicable","tag_available","tag_exists","tag_found","tag_not_applicable","tag_not_found","type_immutable","type_known","type_required","target_active","target_available","target_not_found_or_not_visible","targets_visible","unsupported_linked_record","unsupported_profile_shape","variable_qty_valid","validation_failed","value_nonempty"]},"status":{"type":"string","enum":["passed","blocked"]},"message":{"type":"string"},"param":{"type":"string"}},"required":["code","status","message"],"additionalProperties":false}},"duplicateCandidates":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact","customer","supplier","customer_location","customer_address","supplier_ship_from_location","product","product_family","document"]},"readable":{"type":"boolean"},"version":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","product","purchase_order"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"matchReasons":{"type":"array","items":{"type":"string","enum":["name","email","externalId","address","code","product","url"]}},"readbackPath":{"type":"string"}},"required":["type","readable","matchReasons"],"additionalProperties":false}},"idempotency":{"type":"object","properties":{"required":{"type":"boolean"},"keyProvided":{"type":"boolean"},"wouldReplay":{"type":"boolean"}},"required":["required","keyProvided","wouldReplay"],"additionalProperties":false},"wouldChange":{"type":"object","properties":{"fieldNames":{"type":"array","items":{"type":"string"}},"values":{"type":"object","additionalProperties":{}}},"required":["fieldNames","values"],"additionalProperties":false},"impactAnalysis":{"type":"object","additionalProperties":{}},"requestId":{"type":"string"}},"required":["type","operation","status","wouldWrite","submit","verification","checks","duplicateCandidates","requestId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}]}}}},"201":{"description":"Product family created.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["product_family"]},"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"externalId":{"type":["string","null"]},"casNumber":{"type":["string","null"]},"molecularFormula":{"type":["string","null"]},"unNumbers":{"type":"array","items":{"type":"string"}},"ghsSignalWord":{"type":["string","null"],"enum":["DANGER","WARNING"]},"hazardSymbols":{"type":"array","items":{"type":"string"}},"updatedAt":{"type":"string","format":"date-time"},"url":{"type":"string"},"idempotencyStatus":{"type":"string","enum":["created","replayed"]}},"required":["type","id","name","externalId","casNumber","molecularFormula","unNumbers","ghsSignalWord","hazardSymbols","updatedAt","url"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested parent or record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"409":{"description":"The write conflicted with an existing record, idempotency payload, or stale If-Match value.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/product-families/{id}":{"get":{"operationId":"getPublicAPIProductFamilyReference","summary":"Get a product family reference","description":"Returns one existing product family reference for product setup. This route does not expose SDS files or create families.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":["products:read","products:write","search:read"],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Product family reference detail.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["product_family"]},"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"externalId":{"type":["string","null"]},"casNumber":{"type":["string","null"]},"molecularFormula":{"type":["string","null"]},"unNumbers":{"type":"array","items":{"type":"string"}},"ghsSignalWord":{"type":["string","null"],"enum":["DANGER","WARNING"]},"hazardSymbols":{"type":"array","items":{"type":"string"}},"updatedAt":{"type":"string","format":"date-time"},"url":{"type":"string"},"idempotencyStatus":{"type":"string","enum":["created","replayed"]}},"required":["type","id","name","externalId","casNumber","molecularFormula","unNumbers","ghsSignalWord","hazardSymbols","updatedAt","url"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updatePublicAPIProductFamily","summary":"Update a product family","description":"Updates public-safe product-family identity and regulatory fields. Execute requests require If-Match. dryRun=true may omit If-Match and returns a blocked readiness check instead of writing. Family updates require products:write plus live ProductPermission.update and return impactAnalysis with attached product counts. They never rewrite product rows, orders, documents, product family attributes, superfund/tax fields, inventory, costs, prices, or accounting records.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"products:write","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","enum":["true"]},"required":false,"name":"dryRun","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check."},"required":false,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check.","name":"If-Match","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":240},"externalId":{"type":["string","null"],"maxLength":120},"casNumber":{"type":["string","null"],"maxLength":80},"molecularFormula":{"type":["string","null"],"maxLength":120},"unNumbers":{"type":"array","items":{"type":"string","minLength":1,"maxLength":20}},"ghsSignalWord":{"type":["string","null"],"enum":["DANGER","WARNING"]},"hazardSymbols":{"type":"array","items":{"type":"string","minLength":1,"maxLength":80}}},"additionalProperties":false}}}},"responses":{"200":{"description":"Updated product family, or dryRun returned write readiness.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["product_family"]},"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"externalId":{"type":["string","null"]},"casNumber":{"type":["string","null"]},"molecularFormula":{"type":["string","null"]},"unNumbers":{"type":"array","items":{"type":"string"}},"ghsSignalWord":{"type":["string","null"],"enum":["DANGER","WARNING"]},"hazardSymbols":{"type":"array","items":{"type":"string"}},"updatedAt":{"type":"string","format":"date-time"},"url":{"type":"string"},"idempotencyStatus":{"type":"string","enum":["created","replayed"]}},"required":["type","id","name","externalId","casNumber","molecularFormula","unNumbers","ghsSignalWord","hazardSymbols","updatedAt","url"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["write_readiness"]},"operation":{"type":"string","enum":["warehouses.create","warehouses.update","warehouses.archive","warehouses.unarchive","shipping_options.create","shipping_options.update","shipping_options.archive","shipping_options.unarchive","reorder_points.create","tags.create","tags.update","tag_assignments.create","tag_assignments.delete","notes.create","notes.update","opportunities.create","opportunities.update","opportunities.close","opportunities.meta-upsert","contacts.create","contacts.update","customers.create","customers.update","customer_locations.create","customer_locations.update","customer_addresses.create","customer_addresses.update","suppliers.create","suppliers.update","supplier_ship_from_locations.create","supplier_ship_from_locations.update","products.create","products.update","products.archive","products.unarchive","product_packaging.create","products.suppliers.create","products.suppliers.delete","products.aliases.create","products.aliases.update","products.aliases.delete","product_families.aliases.create","product_families.aliases.update","product_families.aliases.delete","products.customer_part_numbers.create","products.customer_part_numbers.update","products.customer_part_numbers.delete","product_sds.update","product_documents.create","customer_documents.create","supplier_documents.create","purchase_order_documents.create","product_families.create","product_families.update","cost_book_entries.create","current_cost_sources.put","customers.archive","customers.unarchive","suppliers.archive","suppliers.unarchive","contacts.archive","contacts.unarchive","customer_addresses.archive","customer_addresses.unarchive","supplier_ship_from_locations.archive","supplier_ship_from_locations.unarchive","representatives.create","representatives.update","representatives.archive","representatives.unarchive","payment_terms.create","payment_terms.update","ledger_accounts.create","ledger_accounts.update"]},"status":{"type":"string","enum":["ready","blocked"]},"wouldWrite":{"type":"boolean","enum":[false]},"submit":{"type":"object","properties":{"method":{"type":"string","enum":["POST","PATCH","PUT","DELETE"]},"path":{"type":"string"},"query":{"type":"object","properties":{},"additionalProperties":false}},"required":["method","path","query"],"additionalProperties":false},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false},"checks":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["not_direct_ship","address_role_required","address_role_valid","already_assigned","already_exists","active_duplicate","ambiguous_external_id","ambiguous_natural_key","api_created","archived_target","archived_record","archive_blocked","account_type_locked","duplicate_candidate_found","duplicate_candidate_overflow","duplicate_check_clear","duplicate_check_not_needed","duplicate_contact","duplicate_customer","duplicate_customer_address","duplicate_customer_location","duplicate_note","duplicate_resolution_applied","duplicate_supplier","duplicate_supplier_ship_from_location","document_url_org_scoped","document_url_valid","upload_verified","sds_converged","idempotency_available","idempotency_key_required","idempotency_key_reused","idempotency_replay","idempotency_target_missing","income_statement_type_invalid","hard_identity_clear","nested_external_id_clear","commercial_references_valid","credit_denomination_mismatch","customer_service_representative_reference_active","ledger_account_reference_valid","payment_terms_reference_exists","sales_person_reference_active","supplier_representative_reference_active","duplicate_reference_identity","external_id_conflict","if_match_current","base_uom_transition_allowed","base_uom_transition_blocked","attribute_assignments_valid","attribute_assignments_invalid","selected_supplier_link","linked_records_available","natural_key_conflict","not_api_created","no_downstream_mutation","order_sensitive_update_allowed","order_sensitive_update_blocked","parent_available","cost_book_entry_blocked","cost_book_entry_valid","cost_book_reference_not_visible","unsupported_cost_book_uom","cost_uom_conversion_unavailable","cost_book_base_unavailable","cost_book_base_ambiguous","cost_ship_from_location_not_visible","cost_package_quantity_invalid","cost_component_invalid","cost_date_window_invalid","cost_date_overlap","cost_amount_overflow","cost_book_conflict","product_family_reference_active","product_packaging_reference_active","primary_child_available","primary_change_unsupported","reference_visibility_blocked","scope_authorized","stale_record","stale_cost_book_entry","supplier_reference_active","tag_applicable","tag_available","tag_exists","tag_found","tag_not_applicable","tag_not_found","type_immutable","type_known","type_required","target_active","target_available","target_not_found_or_not_visible","targets_visible","unsupported_linked_record","unsupported_profile_shape","variable_qty_valid","validation_failed","value_nonempty"]},"status":{"type":"string","enum":["passed","blocked"]},"message":{"type":"string"},"param":{"type":"string"}},"required":["code","status","message"],"additionalProperties":false}},"duplicateCandidates":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact","customer","supplier","customer_location","customer_address","supplier_ship_from_location","product","product_family","document"]},"readable":{"type":"boolean"},"version":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","product","purchase_order"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"matchReasons":{"type":"array","items":{"type":"string","enum":["name","email","externalId","address","code","product","url"]}},"readbackPath":{"type":"string"}},"required":["type","readable","matchReasons"],"additionalProperties":false}},"idempotency":{"type":"object","properties":{"required":{"type":"boolean"},"keyProvided":{"type":"boolean"},"wouldReplay":{"type":"boolean"}},"required":["required","keyProvided","wouldReplay"],"additionalProperties":false},"wouldChange":{"type":"object","properties":{"fieldNames":{"type":"array","items":{"type":"string"}},"values":{"type":"object","additionalProperties":{}}},"required":["fieldNames","values"],"additionalProperties":false},"impactAnalysis":{"type":"object","additionalProperties":{}},"requestId":{"type":"string"}},"required":["type","operation","status","wouldWrite","submit","verification","checks","duplicateCandidates","requestId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}]}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested parent or record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"409":{"description":"The write conflicted with an existing record, idempotency payload, or stale If-Match value.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/reference/product-packaging":{"get":{"operationId":"listPublicAPIProductPackagingReferences","summary":"List product packaging references","description":"Lists active product packaging references for product setup. This route does not create packaging or expose inventory.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":["products:read","products:write","search:read"],"parameters":[{"schema":{"type":"string"},"required":false,"name":"q","in":"query"},{"schema":{"type":"string"},"required":false,"name":"name","in":"query"},{"schema":{"type":"string"},"required":false,"name":"unitOfMeasure","in":"query"},{"schema":{"type":"string"},"required":false,"name":"limit","in":"query"},{"schema":{"type":"string"},"required":false,"name":"cursor","in":"query"}],"responses":{"200":{"description":"Product packaging reference summaries.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["product_packaging"]},"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"unitOfMeasure":{"type":"string","enum":["GALLON","LITER","POUND","KILOGRAM","EACH","METRIC_TON","SHORT_TON"]},"isBulk":{"type":"boolean"},"tareWeightLbs":{"type":["string","null"]},"capacity":{"type":["string","null"]},"material":{"type":["string","null"]},"unSpecCode":{"type":["string","null"]},"maxGrossWeightLbs":{"type":["string","null"]},"updatedAt":{"type":"string","format":"date-time"}},"required":["type","id","name","unitOfMeasure","isBulk","tareWeightLbs","capacity","material","unSpecCode","maxGrossWeightLbs","updatedAt"],"additionalProperties":false}},"meta":{"type":"object","properties":{"requestId":{"type":"string"},"mode":{"type":"string","enum":["product_reference_lookup"]},"resource":{"type":"string","enum":["product_families","product_packaging"]},"limit":{"type":"integer"},"hasMore":{"type":"boolean"},"truncated":{"type":"boolean"},"sort":{"type":"string","enum":["name_asc"]},"filters":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"nextCursor":{"type":["string","null"]}},"required":["requestId","mode","resource","limit","hasMore","truncated","sort","filters"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/product-packaging":{"post":{"operationId":"createPublicAPIProductPackaging","summary":"Create product packaging","description":"Creates an explicit product-packaging reference. Execute requests require Idempotency-Key. dryRun=true may omit Idempotency-Key and returns a blocked readiness check instead of writing. Execute requires Idempotency-Key.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"products:write","parameters":[{"schema":{"type":"string","enum":["true"]},"required":false,"name":"dryRun","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Required for execute requests. dryRun=true may omit this header and receive an idempotency_key_required check."},"required":false,"description":"Required for execute requests. dryRun=true may omit this header and receive an idempotency_key_required check.","name":"Idempotency-Key","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":240},"unitOfMeasure":{"type":"string","enum":["GALLON","LITER","POUND","KILOGRAM","EACH","METRIC_TON","SHORT_TON"]},"isBulk":{"type":"boolean","default":false},"shape":{"type":["string","null"],"enum":["rectangular","cylindrical","irregular","sphere"]},"tareWeightLbs":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"null"}]},"lengthIn":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"null"}]},"widthIn":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"null"}]},"heightIn":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"null"}]},"diameterIn":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"null"}]},"capacity":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"null"}]},"material":{"type":["string","null"],"enum":["engineered_wood","fiberboard","plastic","steel","wood"]},"unSpecCode":{"type":["string","null"],"maxLength":240},"maxGrossWeightLbs":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"null"}]}},"required":["name","unitOfMeasure"],"additionalProperties":false}}}},"responses":{"200":{"description":"Idempotent replay returned product packaging, or dryRun returned write readiness.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["product_packaging"]},"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"unitOfMeasure":{"type":"string","enum":["GALLON","LITER","POUND","KILOGRAM","EACH","METRIC_TON","SHORT_TON"]},"isBulk":{"type":"boolean"},"shape":{"type":["string","null"]},"tareWeightLbs":{"type":["string","null"]},"lengthIn":{"type":["string","null"]},"widthIn":{"type":["string","null"]},"heightIn":{"type":["string","null"]},"diameterIn":{"type":["string","null"]},"capacity":{"type":["string","null"]},"material":{"type":["string","null"]},"unSpecCode":{"type":["string","null"]},"maxGrossWeightLbs":{"type":["string","null"]},"archived":{"type":"boolean"},"updatedAt":{"type":"string","format":"date-time"},"idempotencyStatus":{"type":"string","enum":["created","replayed"]}},"required":["type","id","name","unitOfMeasure","isBulk","shape","tareWeightLbs","lengthIn","widthIn","heightIn","diameterIn","capacity","material","unSpecCode","maxGrossWeightLbs","archived","updatedAt"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["write_readiness"]},"operation":{"type":"string","enum":["warehouses.create","warehouses.update","warehouses.archive","warehouses.unarchive","shipping_options.create","shipping_options.update","shipping_options.archive","shipping_options.unarchive","reorder_points.create","tags.create","tags.update","tag_assignments.create","tag_assignments.delete","notes.create","notes.update","opportunities.create","opportunities.update","opportunities.close","opportunities.meta-upsert","contacts.create","contacts.update","customers.create","customers.update","customer_locations.create","customer_locations.update","customer_addresses.create","customer_addresses.update","suppliers.create","suppliers.update","supplier_ship_from_locations.create","supplier_ship_from_locations.update","products.create","products.update","products.archive","products.unarchive","product_packaging.create","products.suppliers.create","products.suppliers.delete","products.aliases.create","products.aliases.update","products.aliases.delete","product_families.aliases.create","product_families.aliases.update","product_families.aliases.delete","products.customer_part_numbers.create","products.customer_part_numbers.update","products.customer_part_numbers.delete","product_sds.update","product_documents.create","customer_documents.create","supplier_documents.create","purchase_order_documents.create","product_families.create","product_families.update","cost_book_entries.create","current_cost_sources.put","customers.archive","customers.unarchive","suppliers.archive","suppliers.unarchive","contacts.archive","contacts.unarchive","customer_addresses.archive","customer_addresses.unarchive","supplier_ship_from_locations.archive","supplier_ship_from_locations.unarchive","representatives.create","representatives.update","representatives.archive","representatives.unarchive","payment_terms.create","payment_terms.update","ledger_accounts.create","ledger_accounts.update"]},"status":{"type":"string","enum":["ready","blocked"]},"wouldWrite":{"type":"boolean","enum":[false]},"submit":{"type":"object","properties":{"method":{"type":"string","enum":["POST","PATCH","PUT","DELETE"]},"path":{"type":"string"},"query":{"type":"object","properties":{},"additionalProperties":false}},"required":["method","path","query"],"additionalProperties":false},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false},"checks":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["not_direct_ship","address_role_required","address_role_valid","already_assigned","already_exists","active_duplicate","ambiguous_external_id","ambiguous_natural_key","api_created","archived_target","archived_record","archive_blocked","account_type_locked","duplicate_candidate_found","duplicate_candidate_overflow","duplicate_check_clear","duplicate_check_not_needed","duplicate_contact","duplicate_customer","duplicate_customer_address","duplicate_customer_location","duplicate_note","duplicate_resolution_applied","duplicate_supplier","duplicate_supplier_ship_from_location","document_url_org_scoped","document_url_valid","upload_verified","sds_converged","idempotency_available","idempotency_key_required","idempotency_key_reused","idempotency_replay","idempotency_target_missing","income_statement_type_invalid","hard_identity_clear","nested_external_id_clear","commercial_references_valid","credit_denomination_mismatch","customer_service_representative_reference_active","ledger_account_reference_valid","payment_terms_reference_exists","sales_person_reference_active","supplier_representative_reference_active","duplicate_reference_identity","external_id_conflict","if_match_current","base_uom_transition_allowed","base_uom_transition_blocked","attribute_assignments_valid","attribute_assignments_invalid","selected_supplier_link","linked_records_available","natural_key_conflict","not_api_created","no_downstream_mutation","order_sensitive_update_allowed","order_sensitive_update_blocked","parent_available","cost_book_entry_blocked","cost_book_entry_valid","cost_book_reference_not_visible","unsupported_cost_book_uom","cost_uom_conversion_unavailable","cost_book_base_unavailable","cost_book_base_ambiguous","cost_ship_from_location_not_visible","cost_package_quantity_invalid","cost_component_invalid","cost_date_window_invalid","cost_date_overlap","cost_amount_overflow","cost_book_conflict","product_family_reference_active","product_packaging_reference_active","primary_child_available","primary_change_unsupported","reference_visibility_blocked","scope_authorized","stale_record","stale_cost_book_entry","supplier_reference_active","tag_applicable","tag_available","tag_exists","tag_found","tag_not_applicable","tag_not_found","type_immutable","type_known","type_required","target_active","target_available","target_not_found_or_not_visible","targets_visible","unsupported_linked_record","unsupported_profile_shape","variable_qty_valid","validation_failed","value_nonempty"]},"status":{"type":"string","enum":["passed","blocked"]},"message":{"type":"string"},"param":{"type":"string"}},"required":["code","status","message"],"additionalProperties":false}},"duplicateCandidates":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact","customer","supplier","customer_location","customer_address","supplier_ship_from_location","product","product_family","document"]},"readable":{"type":"boolean"},"version":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","product","purchase_order"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"matchReasons":{"type":"array","items":{"type":"string","enum":["name","email","externalId","address","code","product","url"]}},"readbackPath":{"type":"string"}},"required":["type","readable","matchReasons"],"additionalProperties":false}},"idempotency":{"type":"object","properties":{"required":{"type":"boolean"},"keyProvided":{"type":"boolean"},"wouldReplay":{"type":"boolean"}},"required":["required","keyProvided","wouldReplay"],"additionalProperties":false},"wouldChange":{"type":"object","properties":{"fieldNames":{"type":"array","items":{"type":"string"}},"values":{"type":"object","additionalProperties":{}}},"required":["fieldNames","values"],"additionalProperties":false},"impactAnalysis":{"type":"object","additionalProperties":{}},"requestId":{"type":"string"}},"required":["type","operation","status","wouldWrite","submit","verification","checks","duplicateCandidates","requestId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}]}}}},"201":{"description":"Product packaging created.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["product_packaging"]},"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"unitOfMeasure":{"type":"string","enum":["GALLON","LITER","POUND","KILOGRAM","EACH","METRIC_TON","SHORT_TON"]},"isBulk":{"type":"boolean"},"shape":{"type":["string","null"]},"tareWeightLbs":{"type":["string","null"]},"lengthIn":{"type":["string","null"]},"widthIn":{"type":["string","null"]},"heightIn":{"type":["string","null"]},"diameterIn":{"type":["string","null"]},"capacity":{"type":["string","null"]},"material":{"type":["string","null"]},"unSpecCode":{"type":["string","null"]},"maxGrossWeightLbs":{"type":["string","null"]},"archived":{"type":"boolean"},"updatedAt":{"type":"string","format":"date-time"},"idempotencyStatus":{"type":"string","enum":["created","replayed"]}},"required":["type","id","name","unitOfMeasure","isBulk","shape","tareWeightLbs","lengthIn","widthIn","heightIn","diameterIn","capacity","material","unSpecCode","maxGrossWeightLbs","archived","updatedAt"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested parent or record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"409":{"description":"The write conflicted with an existing record, idempotency payload, or stale If-Match value.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/product-packaging/{id}":{"get":{"operationId":"getPublicAPIProductPackaging","summary":"Get product packaging","description":"Returns one product-packaging reference in the current organization, including its archived state.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":["products:read","products:write","search:read"],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Product packaging detail.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["product_packaging"]},"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"unitOfMeasure":{"type":"string","enum":["GALLON","LITER","POUND","KILOGRAM","EACH","METRIC_TON","SHORT_TON"]},"isBulk":{"type":"boolean"},"shape":{"type":["string","null"]},"tareWeightLbs":{"type":["string","null"]},"lengthIn":{"type":["string","null"]},"widthIn":{"type":["string","null"]},"heightIn":{"type":["string","null"]},"diameterIn":{"type":["string","null"]},"capacity":{"type":["string","null"]},"material":{"type":["string","null"]},"unSpecCode":{"type":["string","null"]},"maxGrossWeightLbs":{"type":["string","null"]},"archived":{"type":"boolean"},"updatedAt":{"type":"string","format":"date-time"},"idempotencyStatus":{"type":"string","enum":["created","replayed"]}},"required":["type","id","name","unitOfMeasure","isBulk","shape","tareWeightLbs","lengthIn","widthIn","heightIn","diameterIn","capacity","material","unSpecCode","maxGrossWeightLbs","archived","updatedAt"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/product-code-attributes":{"get":{"operationId":"listPublicAPIProductCodeAttributes","summary":"List product code attributes","description":"Lists the product code attributes available for Product setup.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":["products:read","products:write","search:read"],"parameters":[{"schema":{"type":"string"},"required":false,"name":"limit","in":"query"},{"schema":{"type":"string"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"string","format":"uuid"},"required":false,"name":"id","in":"query"},{"schema":{"type":"string"},"required":false,"name":"name","in":"query"},{"schema":{"type":"string","enum":["SELECT","MULTISELECT","FREE_TEXT","BOOLEAN"]},"required":false,"name":"type","in":"query"}],"responses":{"200":{"description":"Product code attribute page.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"resourceType":{"type":"string","enum":["product_code_attribute"]},"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"type":{"type":"string","enum":["SELECT","MULTISELECT","FREE_TEXT","BOOLEAN"]},"seq":{"type":"integer"},"updatedAt":{"type":"string","format":"date-time"}},"required":["resourceType","id","name","type","seq","updatedAt"],"additionalProperties":false}},"meta":{"type":"object","properties":{"limit":{"type":"integer","exclusiveMinimum":0},"returnedRecords":{"type":"integer","minimum":0},"hasMore":{"type":"boolean"},"truncated":{"type":"boolean"},"nextCursor":{"type":["string","null"]},"requestId":{"type":"string"},"ownerUpdatedAt":{"type":"string","format":"date-time"}},"required":["limit","returnedRecords","hasMore","truncated","nextCursor","requestId"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/product-code-attributes/{attributeId}/values":{"get":{"operationId":"listPublicAPIProductCodeAttributeValues","summary":"List product code attribute values","description":"Lists the available values for one product code attribute in the current organization.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":["products:read","products:write","search:read"],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"attributeId","in":"path"},{"schema":{"type":"string"},"required":false,"name":"limit","in":"query"},{"schema":{"type":"string"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"string","format":"uuid"},"required":false,"name":"id","in":"query"},{"schema":{"type":"string"},"required":false,"name":"value","in":"query"}],"responses":{"200":{"description":"Product code attribute value page.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["product_code_attribute_value"]},"id":{"type":"string","format":"uuid"},"attributeId":{"type":"string","format":"uuid"},"value":{"type":"string"},"seq":{"type":"integer"},"updatedAt":{"type":"string","format":"date-time"}},"required":["type","id","attributeId","value","seq","updatedAt"],"additionalProperties":false}},"meta":{"type":"object","properties":{"limit":{"type":"integer","exclusiveMinimum":0},"returnedRecords":{"type":"integer","minimum":0},"hasMore":{"type":"boolean"},"truncated":{"type":"boolean"},"nextCursor":{"type":["string","null"]},"requestId":{"type":"string"},"ownerUpdatedAt":{"type":"string","format":"date-time"}},"required":["limit","returnedRecords","hasMore","truncated","nextCursor","requestId"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/products/{id}/attribute-assignments":{"get":{"operationId":"listPublicAPIProductAttributeAssignments","summary":"List product attribute assignments","description":"Returns a product's typed code-attribute assignments with their saved value identities and cursor pagination.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"products:read","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string"},"required":false,"name":"limit","in":"query"},{"schema":{"type":"string"},"required":false,"name":"cursor","in":"query"}],"responses":{"200":{"description":"Product attribute assignment page.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["product_attribute_assignment"]},"id":{"type":"string","format":"uuid"},"attribute":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"type":{"type":"string","enum":["SELECT","MULTISELECT","FREE_TEXT","BOOLEAN"]}},"required":["id","name","type"],"additionalProperties":false,"description":"Null when the stored assignment's definition is missing, inaccessible, or outside the current organization."},"valueType":{"type":"string","enum":["SELECT","MULTISELECT","FREE_TEXT","BOOLEAN"]},"option":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"value":{"type":"string"}},"required":["id","value"],"additionalProperties":false},"textValue":{"type":["string","null"]},"booleanValue":{"type":["boolean","null"]},"status":{"type":"string","enum":["resolved","unresolved"]}},"required":["type","id","attribute","valueType","option","textValue","booleanValue","status"],"additionalProperties":false}},"meta":{"type":"object","properties":{"limit":{"type":"integer","exclusiveMinimum":0},"returnedRecords":{"type":"integer","minimum":0},"hasMore":{"type":"boolean"},"truncated":{"type":"boolean"},"nextCursor":{"type":["string","null"]},"requestId":{"type":"string"},"ownerUpdatedAt":{"type":"string","format":"date-time"}},"required":["limit","returnedRecords","hasMore","truncated","nextCursor","requestId"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/products/{id}/suppliers":{"get":{"operationId":"listPublicAPIProductSuppliers","summary":"List product suppliers","description":"Returns a product's supplier relationships and identifies the selected Current Source when present.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"products:read","x-required-scopes-all":["products:read","suppliers:read"],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string"},"required":false,"name":"limit","in":"query"},{"schema":{"type":"string"},"required":false,"name":"cursor","in":"query"}],"responses":{"200":{"description":"Product supplier page.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["product_supplier"]},"id":{"type":"string","format":"uuid"},"productId":{"type":"string","format":"uuid"},"supplier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"externalId":{"type":["string","null"]},"archived":{"type":"boolean"}},"required":["id","name","externalId","archived"],"additionalProperties":false},"selectedCurrentSource":{"type":"boolean"}},"required":["type","id","productId","supplier","selectedCurrentSource"],"additionalProperties":false}},"meta":{"type":"object","properties":{"limit":{"type":"integer","exclusiveMinimum":0},"returnedRecords":{"type":"integer","minimum":0},"hasMore":{"type":"boolean"},"truncated":{"type":"boolean"},"nextCursor":{"type":["string","null"]},"requestId":{"type":"string"},"ownerUpdatedAt":{"type":"string","format":"date-time"}},"required":["limit","returnedRecords","hasMore","truncated","nextCursor","requestId"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}},"post":{"operationId":"addPublicAPIProductSupplier","summary":"Add a product supplier","description":"Updates one ordinary supplier association. Execute requests require If-Match. dryRun=true may omit If-Match and returns a blocked readiness check instead of writing. Exact repeats are unchanged; this never selects Current Source.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"products:write","x-required-scopes-all":["products:write","suppliers:read"],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","enum":["true"]},"required":false,"name":"dryRun","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check."},"required":false,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check.","name":"If-Match","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"supplierId":{"type":"string","format":"uuid"}},"required":["supplierId"],"additionalProperties":false}}}},"responses":{"200":{"description":"Product supplier receipt or dryRun readiness.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["product_supplier_receipt"]},"productId":{"type":"string","format":"uuid"},"supplierId":{"type":"string","format":"uuid"},"changed":{"type":"boolean"},"updatedAt":{"type":"string","format":"date-time"}},"required":["type","productId","supplierId","changed","updatedAt"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["write_readiness"]},"operation":{"type":"string","enum":["warehouses.create","warehouses.update","warehouses.archive","warehouses.unarchive","shipping_options.create","shipping_options.update","shipping_options.archive","shipping_options.unarchive","reorder_points.create","tags.create","tags.update","tag_assignments.create","tag_assignments.delete","notes.create","notes.update","opportunities.create","opportunities.update","opportunities.close","opportunities.meta-upsert","contacts.create","contacts.update","customers.create","customers.update","customer_locations.create","customer_locations.update","customer_addresses.create","customer_addresses.update","suppliers.create","suppliers.update","supplier_ship_from_locations.create","supplier_ship_from_locations.update","products.create","products.update","products.archive","products.unarchive","product_packaging.create","products.suppliers.create","products.suppliers.delete","products.aliases.create","products.aliases.update","products.aliases.delete","product_families.aliases.create","product_families.aliases.update","product_families.aliases.delete","products.customer_part_numbers.create","products.customer_part_numbers.update","products.customer_part_numbers.delete","product_sds.update","product_documents.create","customer_documents.create","supplier_documents.create","purchase_order_documents.create","product_families.create","product_families.update","cost_book_entries.create","current_cost_sources.put","customers.archive","customers.unarchive","suppliers.archive","suppliers.unarchive","contacts.archive","contacts.unarchive","customer_addresses.archive","customer_addresses.unarchive","supplier_ship_from_locations.archive","supplier_ship_from_locations.unarchive","representatives.create","representatives.update","representatives.archive","representatives.unarchive","payment_terms.create","payment_terms.update","ledger_accounts.create","ledger_accounts.update"]},"status":{"type":"string","enum":["ready","blocked"]},"wouldWrite":{"type":"boolean","enum":[false]},"submit":{"type":"object","properties":{"method":{"type":"string","enum":["POST","PATCH","PUT","DELETE"]},"path":{"type":"string"},"query":{"type":"object","properties":{},"additionalProperties":false}},"required":["method","path","query"],"additionalProperties":false},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false},"checks":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["not_direct_ship","address_role_required","address_role_valid","already_assigned","already_exists","active_duplicate","ambiguous_external_id","ambiguous_natural_key","api_created","archived_target","archived_record","archive_blocked","account_type_locked","duplicate_candidate_found","duplicate_candidate_overflow","duplicate_check_clear","duplicate_check_not_needed","duplicate_contact","duplicate_customer","duplicate_customer_address","duplicate_customer_location","duplicate_note","duplicate_resolution_applied","duplicate_supplier","duplicate_supplier_ship_from_location","document_url_org_scoped","document_url_valid","upload_verified","sds_converged","idempotency_available","idempotency_key_required","idempotency_key_reused","idempotency_replay","idempotency_target_missing","income_statement_type_invalid","hard_identity_clear","nested_external_id_clear","commercial_references_valid","credit_denomination_mismatch","customer_service_representative_reference_active","ledger_account_reference_valid","payment_terms_reference_exists","sales_person_reference_active","supplier_representative_reference_active","duplicate_reference_identity","external_id_conflict","if_match_current","base_uom_transition_allowed","base_uom_transition_blocked","attribute_assignments_valid","attribute_assignments_invalid","selected_supplier_link","linked_records_available","natural_key_conflict","not_api_created","no_downstream_mutation","order_sensitive_update_allowed","order_sensitive_update_blocked","parent_available","cost_book_entry_blocked","cost_book_entry_valid","cost_book_reference_not_visible","unsupported_cost_book_uom","cost_uom_conversion_unavailable","cost_book_base_unavailable","cost_book_base_ambiguous","cost_ship_from_location_not_visible","cost_package_quantity_invalid","cost_component_invalid","cost_date_window_invalid","cost_date_overlap","cost_amount_overflow","cost_book_conflict","product_family_reference_active","product_packaging_reference_active","primary_child_available","primary_change_unsupported","reference_visibility_blocked","scope_authorized","stale_record","stale_cost_book_entry","supplier_reference_active","tag_applicable","tag_available","tag_exists","tag_found","tag_not_applicable","tag_not_found","type_immutable","type_known","type_required","target_active","target_available","target_not_found_or_not_visible","targets_visible","unsupported_linked_record","unsupported_profile_shape","variable_qty_valid","validation_failed","value_nonempty"]},"status":{"type":"string","enum":["passed","blocked"]},"message":{"type":"string"},"param":{"type":"string"}},"required":["code","status","message"],"additionalProperties":false}},"duplicateCandidates":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact","customer","supplier","customer_location","customer_address","supplier_ship_from_location","product","product_family","document"]},"readable":{"type":"boolean"},"version":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","product","purchase_order"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"matchReasons":{"type":"array","items":{"type":"string","enum":["name","email","externalId","address","code","product","url"]}},"readbackPath":{"type":"string"}},"required":["type","readable","matchReasons"],"additionalProperties":false}},"idempotency":{"type":"object","properties":{"required":{"type":"boolean"},"keyProvided":{"type":"boolean"},"wouldReplay":{"type":"boolean"}},"required":["required","keyProvided","wouldReplay"],"additionalProperties":false},"wouldChange":{"type":"object","properties":{"fieldNames":{"type":"array","items":{"type":"string"}},"values":{"type":"object","additionalProperties":{}}},"required":["fieldNames","values"],"additionalProperties":false},"impactAnalysis":{"type":"object","additionalProperties":{}},"requestId":{"type":"string"}},"required":["type","operation","status","wouldWrite","submit","verification","checks","duplicateCandidates","requestId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}]}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested parent or record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"409":{"description":"The write conflicted with an existing record, idempotency payload, or stale If-Match value.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/products/{id}/suppliers/{supplierId}":{"delete":{"operationId":"removePublicAPIProductSupplier","summary":"Remove a product supplier","description":"Updates one ordinary supplier association. Execute requests require If-Match. dryRun=true may omit If-Match and returns a blocked readiness check instead of writing. The selected Current Source link cannot be removed.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"products:write","x-required-scopes-all":["products:write","suppliers:read"],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"supplierId","in":"path"},{"schema":{"type":"string","enum":["true"]},"required":false,"name":"dryRun","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check."},"required":false,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check.","name":"If-Match","in":"header"}],"responses":{"200":{"description":"Product supplier receipt or dryRun readiness.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["product_supplier_receipt"]},"productId":{"type":"string","format":"uuid"},"supplierId":{"type":"string","format":"uuid"},"changed":{"type":"boolean"},"updatedAt":{"type":"string","format":"date-time"}},"required":["type","productId","supplierId","changed","updatedAt"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["write_readiness"]},"operation":{"type":"string","enum":["warehouses.create","warehouses.update","warehouses.archive","warehouses.unarchive","shipping_options.create","shipping_options.update","shipping_options.archive","shipping_options.unarchive","reorder_points.create","tags.create","tags.update","tag_assignments.create","tag_assignments.delete","notes.create","notes.update","opportunities.create","opportunities.update","opportunities.close","opportunities.meta-upsert","contacts.create","contacts.update","customers.create","customers.update","customer_locations.create","customer_locations.update","customer_addresses.create","customer_addresses.update","suppliers.create","suppliers.update","supplier_ship_from_locations.create","supplier_ship_from_locations.update","products.create","products.update","products.archive","products.unarchive","product_packaging.create","products.suppliers.create","products.suppliers.delete","products.aliases.create","products.aliases.update","products.aliases.delete","product_families.aliases.create","product_families.aliases.update","product_families.aliases.delete","products.customer_part_numbers.create","products.customer_part_numbers.update","products.customer_part_numbers.delete","product_sds.update","product_documents.create","customer_documents.create","supplier_documents.create","purchase_order_documents.create","product_families.create","product_families.update","cost_book_entries.create","current_cost_sources.put","customers.archive","customers.unarchive","suppliers.archive","suppliers.unarchive","contacts.archive","contacts.unarchive","customer_addresses.archive","customer_addresses.unarchive","supplier_ship_from_locations.archive","supplier_ship_from_locations.unarchive","representatives.create","representatives.update","representatives.archive","representatives.unarchive","payment_terms.create","payment_terms.update","ledger_accounts.create","ledger_accounts.update"]},"status":{"type":"string","enum":["ready","blocked"]},"wouldWrite":{"type":"boolean","enum":[false]},"submit":{"type":"object","properties":{"method":{"type":"string","enum":["POST","PATCH","PUT","DELETE"]},"path":{"type":"string"},"query":{"type":"object","properties":{},"additionalProperties":false}},"required":["method","path","query"],"additionalProperties":false},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false},"checks":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["not_direct_ship","address_role_required","address_role_valid","already_assigned","already_exists","active_duplicate","ambiguous_external_id","ambiguous_natural_key","api_created","archived_target","archived_record","archive_blocked","account_type_locked","duplicate_candidate_found","duplicate_candidate_overflow","duplicate_check_clear","duplicate_check_not_needed","duplicate_contact","duplicate_customer","duplicate_customer_address","duplicate_customer_location","duplicate_note","duplicate_resolution_applied","duplicate_supplier","duplicate_supplier_ship_from_location","document_url_org_scoped","document_url_valid","upload_verified","sds_converged","idempotency_available","idempotency_key_required","idempotency_key_reused","idempotency_replay","idempotency_target_missing","income_statement_type_invalid","hard_identity_clear","nested_external_id_clear","commercial_references_valid","credit_denomination_mismatch","customer_service_representative_reference_active","ledger_account_reference_valid","payment_terms_reference_exists","sales_person_reference_active","supplier_representative_reference_active","duplicate_reference_identity","external_id_conflict","if_match_current","base_uom_transition_allowed","base_uom_transition_blocked","attribute_assignments_valid","attribute_assignments_invalid","selected_supplier_link","linked_records_available","natural_key_conflict","not_api_created","no_downstream_mutation","order_sensitive_update_allowed","order_sensitive_update_blocked","parent_available","cost_book_entry_blocked","cost_book_entry_valid","cost_book_reference_not_visible","unsupported_cost_book_uom","cost_uom_conversion_unavailable","cost_book_base_unavailable","cost_book_base_ambiguous","cost_ship_from_location_not_visible","cost_package_quantity_invalid","cost_component_invalid","cost_date_window_invalid","cost_date_overlap","cost_amount_overflow","cost_book_conflict","product_family_reference_active","product_packaging_reference_active","primary_child_available","primary_change_unsupported","reference_visibility_blocked","scope_authorized","stale_record","stale_cost_book_entry","supplier_reference_active","tag_applicable","tag_available","tag_exists","tag_found","tag_not_applicable","tag_not_found","type_immutable","type_known","type_required","target_active","target_available","target_not_found_or_not_visible","targets_visible","unsupported_linked_record","unsupported_profile_shape","variable_qty_valid","validation_failed","value_nonempty"]},"status":{"type":"string","enum":["passed","blocked"]},"message":{"type":"string"},"param":{"type":"string"}},"required":["code","status","message"],"additionalProperties":false}},"duplicateCandidates":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact","customer","supplier","customer_location","customer_address","supplier_ship_from_location","product","product_family","document"]},"readable":{"type":"boolean"},"version":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","product","purchase_order"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"matchReasons":{"type":"array","items":{"type":"string","enum":["name","email","externalId","address","code","product","url"]}},"readbackPath":{"type":"string"}},"required":["type","readable","matchReasons"],"additionalProperties":false}},"idempotency":{"type":"object","properties":{"required":{"type":"boolean"},"keyProvided":{"type":"boolean"},"wouldReplay":{"type":"boolean"}},"required":["required","keyProvided","wouldReplay"],"additionalProperties":false},"wouldChange":{"type":"object","properties":{"fieldNames":{"type":"array","items":{"type":"string"}},"values":{"type":"object","additionalProperties":{}}},"required":["fieldNames","values"],"additionalProperties":false},"impactAnalysis":{"type":"object","additionalProperties":{}},"requestId":{"type":"string"}},"required":["type","operation","status","wouldWrite","submit","verification","checks","duplicateCandidates","requestId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}]}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested parent or record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"409":{"description":"The write conflicted with an existing record, idempotency payload, or stale If-Match value.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/products/{id}/aliases":{"get":{"operationId":"listPublicAPIProductAliases","summary":"List product aliases","description":"Returns the aliases available to the acting person, including their organization-wide, customer, or supplier context.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"products:read","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string"},"required":false,"name":"limit","in":"query"},{"schema":{"type":"string"},"required":false,"name":"cursor","in":"query"}],"responses":{"200":{"description":"Product alias page.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["product_alias"]},"id":{"type":"string","format":"uuid"},"value":{"type":"string"},"context":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["global"]}},"required":["type"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["customer"]},"customerId":{"type":"string","format":"uuid"}},"required":["type","customerId"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["supplier"]},"supplierId":{"type":"string","format":"uuid"}},"required":["type","supplierId"],"additionalProperties":false},{"type":"null"}]},"status":{"type":"string","enum":["resolved","unresolved","conflicting"]},"ownerUpdatedAt":{"type":"string","format":"date-time"},"idempotencyStatus":{"type":"string","enum":["created","replayed"]}},"required":["type","id","value","context","status","ownerUpdatedAt"],"additionalProperties":false}},"meta":{"type":"object","properties":{"limit":{"type":"integer","exclusiveMinimum":0},"returnedRecords":{"type":"integer","minimum":0},"hasMore":{"type":"boolean"},"truncated":{"type":"boolean"},"nextCursor":{"type":["string","null"]},"requestId":{"type":"string"},"ownerUpdatedAt":{"type":"string","format":"date-time"}},"required":["limit","returnedRecords","hasMore","truncated","nextCursor","requestId"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}},"post":{"operationId":"createPublicAPIProductAlias","summary":"Create a product alias","description":"Creates one organization-wide, customer-specific, or supplier-specific alias. Execute requests require Idempotency-Key. dryRun=true may omit Idempotency-Key and returns a blocked readiness check instead of writing. The alias keeps the owner and context selected when it was created.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"products:write","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","enum":["true"]},"required":false,"name":"dryRun","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Required for execute requests. dryRun=true may omit this header and receive an idempotency_key_required check."},"required":false,"description":"Required for execute requests. dryRun=true may omit this header and receive an idempotency_key_required check.","name":"Idempotency-Key","in":"header"},{"schema":{"type":"string","minLength":1,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check."},"required":false,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check.","name":"If-Match","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"value":{"type":"string","minLength":1,"maxLength":240},"context":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["global"]}},"required":["type"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["customer"]},"customerId":{"type":"string","format":"uuid"}},"required":["type","customerId"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["supplier"]},"supplierId":{"type":"string","format":"uuid"}},"required":["type","supplierId"],"additionalProperties":false}]}},"required":["value","context"],"additionalProperties":false}}}},"responses":{"200":{"description":"Product alias replay or dryRun readiness.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["product_alias"]},"id":{"type":"string","format":"uuid"},"value":{"type":"string"},"context":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["global"]}},"required":["type"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["customer"]},"customerId":{"type":"string","format":"uuid"}},"required":["type","customerId"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["supplier"]},"supplierId":{"type":"string","format":"uuid"}},"required":["type","supplierId"],"additionalProperties":false},{"type":"null"}]},"status":{"type":"string","enum":["resolved","unresolved","conflicting"]},"ownerUpdatedAt":{"type":"string","format":"date-time"},"idempotencyStatus":{"type":"string","enum":["created","replayed"]}},"required":["type","id","value","context","status","ownerUpdatedAt"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["write_readiness"]},"operation":{"type":"string","enum":["warehouses.create","warehouses.update","warehouses.archive","warehouses.unarchive","shipping_options.create","shipping_options.update","shipping_options.archive","shipping_options.unarchive","reorder_points.create","tags.create","tags.update","tag_assignments.create","tag_assignments.delete","notes.create","notes.update","opportunities.create","opportunities.update","opportunities.close","opportunities.meta-upsert","contacts.create","contacts.update","customers.create","customers.update","customer_locations.create","customer_locations.update","customer_addresses.create","customer_addresses.update","suppliers.create","suppliers.update","supplier_ship_from_locations.create","supplier_ship_from_locations.update","products.create","products.update","products.archive","products.unarchive","product_packaging.create","products.suppliers.create","products.suppliers.delete","products.aliases.create","products.aliases.update","products.aliases.delete","product_families.aliases.create","product_families.aliases.update","product_families.aliases.delete","products.customer_part_numbers.create","products.customer_part_numbers.update","products.customer_part_numbers.delete","product_sds.update","product_documents.create","customer_documents.create","supplier_documents.create","purchase_order_documents.create","product_families.create","product_families.update","cost_book_entries.create","current_cost_sources.put","customers.archive","customers.unarchive","suppliers.archive","suppliers.unarchive","contacts.archive","contacts.unarchive","customer_addresses.archive","customer_addresses.unarchive","supplier_ship_from_locations.archive","supplier_ship_from_locations.unarchive","representatives.create","representatives.update","representatives.archive","representatives.unarchive","payment_terms.create","payment_terms.update","ledger_accounts.create","ledger_accounts.update"]},"status":{"type":"string","enum":["ready","blocked"]},"wouldWrite":{"type":"boolean","enum":[false]},"submit":{"type":"object","properties":{"method":{"type":"string","enum":["POST","PATCH","PUT","DELETE"]},"path":{"type":"string"},"query":{"type":"object","properties":{},"additionalProperties":false}},"required":["method","path","query"],"additionalProperties":false},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false},"checks":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["not_direct_ship","address_role_required","address_role_valid","already_assigned","already_exists","active_duplicate","ambiguous_external_id","ambiguous_natural_key","api_created","archived_target","archived_record","archive_blocked","account_type_locked","duplicate_candidate_found","duplicate_candidate_overflow","duplicate_check_clear","duplicate_check_not_needed","duplicate_contact","duplicate_customer","duplicate_customer_address","duplicate_customer_location","duplicate_note","duplicate_resolution_applied","duplicate_supplier","duplicate_supplier_ship_from_location","document_url_org_scoped","document_url_valid","upload_verified","sds_converged","idempotency_available","idempotency_key_required","idempotency_key_reused","idempotency_replay","idempotency_target_missing","income_statement_type_invalid","hard_identity_clear","nested_external_id_clear","commercial_references_valid","credit_denomination_mismatch","customer_service_representative_reference_active","ledger_account_reference_valid","payment_terms_reference_exists","sales_person_reference_active","supplier_representative_reference_active","duplicate_reference_identity","external_id_conflict","if_match_current","base_uom_transition_allowed","base_uom_transition_blocked","attribute_assignments_valid","attribute_assignments_invalid","selected_supplier_link","linked_records_available","natural_key_conflict","not_api_created","no_downstream_mutation","order_sensitive_update_allowed","order_sensitive_update_blocked","parent_available","cost_book_entry_blocked","cost_book_entry_valid","cost_book_reference_not_visible","unsupported_cost_book_uom","cost_uom_conversion_unavailable","cost_book_base_unavailable","cost_book_base_ambiguous","cost_ship_from_location_not_visible","cost_package_quantity_invalid","cost_component_invalid","cost_date_window_invalid","cost_date_overlap","cost_amount_overflow","cost_book_conflict","product_family_reference_active","product_packaging_reference_active","primary_child_available","primary_change_unsupported","reference_visibility_blocked","scope_authorized","stale_record","stale_cost_book_entry","supplier_reference_active","tag_applicable","tag_available","tag_exists","tag_found","tag_not_applicable","tag_not_found","type_immutable","type_known","type_required","target_active","target_available","target_not_found_or_not_visible","targets_visible","unsupported_linked_record","unsupported_profile_shape","variable_qty_valid","validation_failed","value_nonempty"]},"status":{"type":"string","enum":["passed","blocked"]},"message":{"type":"string"},"param":{"type":"string"}},"required":["code","status","message"],"additionalProperties":false}},"duplicateCandidates":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact","customer","supplier","customer_location","customer_address","supplier_ship_from_location","product","product_family","document"]},"readable":{"type":"boolean"},"version":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","product","purchase_order"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"matchReasons":{"type":"array","items":{"type":"string","enum":["name","email","externalId","address","code","product","url"]}},"readbackPath":{"type":"string"}},"required":["type","readable","matchReasons"],"additionalProperties":false}},"idempotency":{"type":"object","properties":{"required":{"type":"boolean"},"keyProvided":{"type":"boolean"},"wouldReplay":{"type":"boolean"}},"required":["required","keyProvided","wouldReplay"],"additionalProperties":false},"wouldChange":{"type":"object","properties":{"fieldNames":{"type":"array","items":{"type":"string"}},"values":{"type":"object","additionalProperties":{}}},"required":["fieldNames","values"],"additionalProperties":false},"impactAnalysis":{"type":"object","additionalProperties":{}},"requestId":{"type":"string"}},"required":["type","operation","status","wouldWrite","submit","verification","checks","duplicateCandidates","requestId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}]}}}},"201":{"description":"Product alias created.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["product_alias"]},"id":{"type":"string","format":"uuid"},"value":{"type":"string"},"context":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["global"]}},"required":["type"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["customer"]},"customerId":{"type":"string","format":"uuid"}},"required":["type","customerId"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["supplier"]},"supplierId":{"type":"string","format":"uuid"}},"required":["type","supplierId"],"additionalProperties":false},{"type":"null"}]},"status":{"type":"string","enum":["resolved","unresolved","conflicting"]},"ownerUpdatedAt":{"type":"string","format":"date-time"},"idempotencyStatus":{"type":"string","enum":["created","replayed"]}},"required":["type","id","value","context","status","ownerUpdatedAt"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested parent or record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"409":{"description":"The write conflicted with an existing record, idempotency payload, or stale If-Match value.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/products/{id}/aliases/{aliasId}":{"patch":{"operationId":"updatePublicAPIProductAlias","summary":"Update a product alias","description":"Updates the alias display value; the owner and context stay as created. Execute requests require If-Match. dryRun=true may omit If-Match and returns a blocked readiness check instead of writing.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"products:write","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"aliasId","in":"path"},{"schema":{"type":"string","enum":["true"]},"required":false,"name":"dryRun","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check."},"required":false,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check.","name":"If-Match","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"value":{"type":"string","minLength":1,"maxLength":240}},"required":["value"],"additionalProperties":false}}}},"responses":{"200":{"description":"Product alias or dryRun readiness.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["product_alias"]},"id":{"type":"string","format":"uuid"},"value":{"type":"string"},"context":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["global"]}},"required":["type"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["customer"]},"customerId":{"type":"string","format":"uuid"}},"required":["type","customerId"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["supplier"]},"supplierId":{"type":"string","format":"uuid"}},"required":["type","supplierId"],"additionalProperties":false},{"type":"null"}]},"status":{"type":"string","enum":["resolved","unresolved","conflicting"]},"ownerUpdatedAt":{"type":"string","format":"date-time"},"idempotencyStatus":{"type":"string","enum":["created","replayed"]}},"required":["type","id","value","context","status","ownerUpdatedAt"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["write_readiness"]},"operation":{"type":"string","enum":["warehouses.create","warehouses.update","warehouses.archive","warehouses.unarchive","shipping_options.create","shipping_options.update","shipping_options.archive","shipping_options.unarchive","reorder_points.create","tags.create","tags.update","tag_assignments.create","tag_assignments.delete","notes.create","notes.update","opportunities.create","opportunities.update","opportunities.close","opportunities.meta-upsert","contacts.create","contacts.update","customers.create","customers.update","customer_locations.create","customer_locations.update","customer_addresses.create","customer_addresses.update","suppliers.create","suppliers.update","supplier_ship_from_locations.create","supplier_ship_from_locations.update","products.create","products.update","products.archive","products.unarchive","product_packaging.create","products.suppliers.create","products.suppliers.delete","products.aliases.create","products.aliases.update","products.aliases.delete","product_families.aliases.create","product_families.aliases.update","product_families.aliases.delete","products.customer_part_numbers.create","products.customer_part_numbers.update","products.customer_part_numbers.delete","product_sds.update","product_documents.create","customer_documents.create","supplier_documents.create","purchase_order_documents.create","product_families.create","product_families.update","cost_book_entries.create","current_cost_sources.put","customers.archive","customers.unarchive","suppliers.archive","suppliers.unarchive","contacts.archive","contacts.unarchive","customer_addresses.archive","customer_addresses.unarchive","supplier_ship_from_locations.archive","supplier_ship_from_locations.unarchive","representatives.create","representatives.update","representatives.archive","representatives.unarchive","payment_terms.create","payment_terms.update","ledger_accounts.create","ledger_accounts.update"]},"status":{"type":"string","enum":["ready","blocked"]},"wouldWrite":{"type":"boolean","enum":[false]},"submit":{"type":"object","properties":{"method":{"type":"string","enum":["POST","PATCH","PUT","DELETE"]},"path":{"type":"string"},"query":{"type":"object","properties":{},"additionalProperties":false}},"required":["method","path","query"],"additionalProperties":false},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false},"checks":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["not_direct_ship","address_role_required","address_role_valid","already_assigned","already_exists","active_duplicate","ambiguous_external_id","ambiguous_natural_key","api_created","archived_target","archived_record","archive_blocked","account_type_locked","duplicate_candidate_found","duplicate_candidate_overflow","duplicate_check_clear","duplicate_check_not_needed","duplicate_contact","duplicate_customer","duplicate_customer_address","duplicate_customer_location","duplicate_note","duplicate_resolution_applied","duplicate_supplier","duplicate_supplier_ship_from_location","document_url_org_scoped","document_url_valid","upload_verified","sds_converged","idempotency_available","idempotency_key_required","idempotency_key_reused","idempotency_replay","idempotency_target_missing","income_statement_type_invalid","hard_identity_clear","nested_external_id_clear","commercial_references_valid","credit_denomination_mismatch","customer_service_representative_reference_active","ledger_account_reference_valid","payment_terms_reference_exists","sales_person_reference_active","supplier_representative_reference_active","duplicate_reference_identity","external_id_conflict","if_match_current","base_uom_transition_allowed","base_uom_transition_blocked","attribute_assignments_valid","attribute_assignments_invalid","selected_supplier_link","linked_records_available","natural_key_conflict","not_api_created","no_downstream_mutation","order_sensitive_update_allowed","order_sensitive_update_blocked","parent_available","cost_book_entry_blocked","cost_book_entry_valid","cost_book_reference_not_visible","unsupported_cost_book_uom","cost_uom_conversion_unavailable","cost_book_base_unavailable","cost_book_base_ambiguous","cost_ship_from_location_not_visible","cost_package_quantity_invalid","cost_component_invalid","cost_date_window_invalid","cost_date_overlap","cost_amount_overflow","cost_book_conflict","product_family_reference_active","product_packaging_reference_active","primary_child_available","primary_change_unsupported","reference_visibility_blocked","scope_authorized","stale_record","stale_cost_book_entry","supplier_reference_active","tag_applicable","tag_available","tag_exists","tag_found","tag_not_applicable","tag_not_found","type_immutable","type_known","type_required","target_active","target_available","target_not_found_or_not_visible","targets_visible","unsupported_linked_record","unsupported_profile_shape","variable_qty_valid","validation_failed","value_nonempty"]},"status":{"type":"string","enum":["passed","blocked"]},"message":{"type":"string"},"param":{"type":"string"}},"required":["code","status","message"],"additionalProperties":false}},"duplicateCandidates":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact","customer","supplier","customer_location","customer_address","supplier_ship_from_location","product","product_family","document"]},"readable":{"type":"boolean"},"version":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","product","purchase_order"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"matchReasons":{"type":"array","items":{"type":"string","enum":["name","email","externalId","address","code","product","url"]}},"readbackPath":{"type":"string"}},"required":["type","readable","matchReasons"],"additionalProperties":false}},"idempotency":{"type":"object","properties":{"required":{"type":"boolean"},"keyProvided":{"type":"boolean"},"wouldReplay":{"type":"boolean"}},"required":["required","keyProvided","wouldReplay"],"additionalProperties":false},"wouldChange":{"type":"object","properties":{"fieldNames":{"type":"array","items":{"type":"string"}},"values":{"type":"object","additionalProperties":{}}},"required":["fieldNames","values"],"additionalProperties":false},"impactAnalysis":{"type":"object","additionalProperties":{}},"requestId":{"type":"string"}},"required":["type","operation","status","wouldWrite","submit","verification","checks","duplicateCandidates","requestId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}]}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested parent or record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"409":{"description":"The write conflicted with an existing record, idempotency payload, or stale If-Match value.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}},"delete":{"operationId":"removePublicAPIProductAlias","summary":"Remove a product alias","description":"Removes the alias relationship. Execute requests require If-Match; dryRun=true may omit it and returns a blocked check when it is missing. After access, archive-state, and version checks pass, removing an alias that is not attached to the selected owner returns changed:false and leaves the owner timestamp unchanged.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"products:write","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"aliasId","in":"path"},{"schema":{"type":"string","enum":["true"]},"required":false,"name":"dryRun","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check."},"required":false,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check.","name":"If-Match","in":"header"}],"responses":{"200":{"description":"Product alias receipt or dryRun readiness.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["product_alias_receipt"]},"id":{"type":"string","format":"uuid"},"changed":{"type":"boolean"},"ownerUpdatedAt":{"type":"string","format":"date-time"}},"required":["type","id","changed","ownerUpdatedAt"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["write_readiness"]},"operation":{"type":"string","enum":["warehouses.create","warehouses.update","warehouses.archive","warehouses.unarchive","shipping_options.create","shipping_options.update","shipping_options.archive","shipping_options.unarchive","reorder_points.create","tags.create","tags.update","tag_assignments.create","tag_assignments.delete","notes.create","notes.update","opportunities.create","opportunities.update","opportunities.close","opportunities.meta-upsert","contacts.create","contacts.update","customers.create","customers.update","customer_locations.create","customer_locations.update","customer_addresses.create","customer_addresses.update","suppliers.create","suppliers.update","supplier_ship_from_locations.create","supplier_ship_from_locations.update","products.create","products.update","products.archive","products.unarchive","product_packaging.create","products.suppliers.create","products.suppliers.delete","products.aliases.create","products.aliases.update","products.aliases.delete","product_families.aliases.create","product_families.aliases.update","product_families.aliases.delete","products.customer_part_numbers.create","products.customer_part_numbers.update","products.customer_part_numbers.delete","product_sds.update","product_documents.create","customer_documents.create","supplier_documents.create","purchase_order_documents.create","product_families.create","product_families.update","cost_book_entries.create","current_cost_sources.put","customers.archive","customers.unarchive","suppliers.archive","suppliers.unarchive","contacts.archive","contacts.unarchive","customer_addresses.archive","customer_addresses.unarchive","supplier_ship_from_locations.archive","supplier_ship_from_locations.unarchive","representatives.create","representatives.update","representatives.archive","representatives.unarchive","payment_terms.create","payment_terms.update","ledger_accounts.create","ledger_accounts.update"]},"status":{"type":"string","enum":["ready","blocked"]},"wouldWrite":{"type":"boolean","enum":[false]},"submit":{"type":"object","properties":{"method":{"type":"string","enum":["POST","PATCH","PUT","DELETE"]},"path":{"type":"string"},"query":{"type":"object","properties":{},"additionalProperties":false}},"required":["method","path","query"],"additionalProperties":false},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false},"checks":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["not_direct_ship","address_role_required","address_role_valid","already_assigned","already_exists","active_duplicate","ambiguous_external_id","ambiguous_natural_key","api_created","archived_target","archived_record","archive_blocked","account_type_locked","duplicate_candidate_found","duplicate_candidate_overflow","duplicate_check_clear","duplicate_check_not_needed","duplicate_contact","duplicate_customer","duplicate_customer_address","duplicate_customer_location","duplicate_note","duplicate_resolution_applied","duplicate_supplier","duplicate_supplier_ship_from_location","document_url_org_scoped","document_url_valid","upload_verified","sds_converged","idempotency_available","idempotency_key_required","idempotency_key_reused","idempotency_replay","idempotency_target_missing","income_statement_type_invalid","hard_identity_clear","nested_external_id_clear","commercial_references_valid","credit_denomination_mismatch","customer_service_representative_reference_active","ledger_account_reference_valid","payment_terms_reference_exists","sales_person_reference_active","supplier_representative_reference_active","duplicate_reference_identity","external_id_conflict","if_match_current","base_uom_transition_allowed","base_uom_transition_blocked","attribute_assignments_valid","attribute_assignments_invalid","selected_supplier_link","linked_records_available","natural_key_conflict","not_api_created","no_downstream_mutation","order_sensitive_update_allowed","order_sensitive_update_blocked","parent_available","cost_book_entry_blocked","cost_book_entry_valid","cost_book_reference_not_visible","unsupported_cost_book_uom","cost_uom_conversion_unavailable","cost_book_base_unavailable","cost_book_base_ambiguous","cost_ship_from_location_not_visible","cost_package_quantity_invalid","cost_component_invalid","cost_date_window_invalid","cost_date_overlap","cost_amount_overflow","cost_book_conflict","product_family_reference_active","product_packaging_reference_active","primary_child_available","primary_change_unsupported","reference_visibility_blocked","scope_authorized","stale_record","stale_cost_book_entry","supplier_reference_active","tag_applicable","tag_available","tag_exists","tag_found","tag_not_applicable","tag_not_found","type_immutable","type_known","type_required","target_active","target_available","target_not_found_or_not_visible","targets_visible","unsupported_linked_record","unsupported_profile_shape","variable_qty_valid","validation_failed","value_nonempty"]},"status":{"type":"string","enum":["passed","blocked"]},"message":{"type":"string"},"param":{"type":"string"}},"required":["code","status","message"],"additionalProperties":false}},"duplicateCandidates":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact","customer","supplier","customer_location","customer_address","supplier_ship_from_location","product","product_family","document"]},"readable":{"type":"boolean"},"version":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","product","purchase_order"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"matchReasons":{"type":"array","items":{"type":"string","enum":["name","email","externalId","address","code","product","url"]}},"readbackPath":{"type":"string"}},"required":["type","readable","matchReasons"],"additionalProperties":false}},"idempotency":{"type":"object","properties":{"required":{"type":"boolean"},"keyProvided":{"type":"boolean"},"wouldReplay":{"type":"boolean"}},"required":["required","keyProvided","wouldReplay"],"additionalProperties":false},"wouldChange":{"type":"object","properties":{"fieldNames":{"type":"array","items":{"type":"string"}},"values":{"type":"object","additionalProperties":{}}},"required":["fieldNames","values"],"additionalProperties":false},"impactAnalysis":{"type":"object","additionalProperties":{}},"requestId":{"type":"string"}},"required":["type","operation","status","wouldWrite","submit","verification","checks","duplicateCandidates","requestId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}]}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested parent or record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"409":{"description":"The write conflicted with an existing record, idempotency payload, or stale If-Match value.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/product-families/{id}/aliases":{"get":{"operationId":"listPublicAPIProductFamilyAliases","summary":"List product family aliases","description":"Returns the aliases available to the acting person, including their organization-wide, customer, or supplier context.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"products:read","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string"},"required":false,"name":"limit","in":"query"},{"schema":{"type":"string"},"required":false,"name":"cursor","in":"query"}],"responses":{"200":{"description":"Product family alias page.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["product_alias"]},"id":{"type":"string","format":"uuid"},"value":{"type":"string"},"context":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["global"]}},"required":["type"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["customer"]},"customerId":{"type":"string","format":"uuid"}},"required":["type","customerId"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["supplier"]},"supplierId":{"type":"string","format":"uuid"}},"required":["type","supplierId"],"additionalProperties":false},{"type":"null"}]},"status":{"type":"string","enum":["resolved","unresolved","conflicting"]},"ownerUpdatedAt":{"type":"string","format":"date-time"},"idempotencyStatus":{"type":"string","enum":["created","replayed"]}},"required":["type","id","value","context","status","ownerUpdatedAt"],"additionalProperties":false}},"meta":{"type":"object","properties":{"limit":{"type":"integer","exclusiveMinimum":0},"returnedRecords":{"type":"integer","minimum":0},"hasMore":{"type":"boolean"},"truncated":{"type":"boolean"},"nextCursor":{"type":["string","null"]},"requestId":{"type":"string"},"ownerUpdatedAt":{"type":"string","format":"date-time"}},"required":["limit","returnedRecords","hasMore","truncated","nextCursor","requestId"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}},"post":{"operationId":"createPublicAPIProductFamilyAlias","summary":"Create a product family alias","description":"Creates one organization-wide, customer-specific, or supplier-specific alias. Execute requests require Idempotency-Key. dryRun=true may omit Idempotency-Key and returns a blocked readiness check instead of writing. The alias keeps the owner and context selected when it was created.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"products:write","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","enum":["true"]},"required":false,"name":"dryRun","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Required for execute requests. dryRun=true may omit this header and receive an idempotency_key_required check."},"required":false,"description":"Required for execute requests. dryRun=true may omit this header and receive an idempotency_key_required check.","name":"Idempotency-Key","in":"header"},{"schema":{"type":"string","minLength":1,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check."},"required":false,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check.","name":"If-Match","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"value":{"type":"string","minLength":1,"maxLength":240},"context":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["global"]}},"required":["type"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["customer"]},"customerId":{"type":"string","format":"uuid"}},"required":["type","customerId"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["supplier"]},"supplierId":{"type":"string","format":"uuid"}},"required":["type","supplierId"],"additionalProperties":false}]}},"required":["value","context"],"additionalProperties":false}}}},"responses":{"200":{"description":"Product family alias replay or dryRun readiness.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["product_alias"]},"id":{"type":"string","format":"uuid"},"value":{"type":"string"},"context":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["global"]}},"required":["type"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["customer"]},"customerId":{"type":"string","format":"uuid"}},"required":["type","customerId"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["supplier"]},"supplierId":{"type":"string","format":"uuid"}},"required":["type","supplierId"],"additionalProperties":false},{"type":"null"}]},"status":{"type":"string","enum":["resolved","unresolved","conflicting"]},"ownerUpdatedAt":{"type":"string","format":"date-time"},"idempotencyStatus":{"type":"string","enum":["created","replayed"]}},"required":["type","id","value","context","status","ownerUpdatedAt"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["write_readiness"]},"operation":{"type":"string","enum":["warehouses.create","warehouses.update","warehouses.archive","warehouses.unarchive","shipping_options.create","shipping_options.update","shipping_options.archive","shipping_options.unarchive","reorder_points.create","tags.create","tags.update","tag_assignments.create","tag_assignments.delete","notes.create","notes.update","opportunities.create","opportunities.update","opportunities.close","opportunities.meta-upsert","contacts.create","contacts.update","customers.create","customers.update","customer_locations.create","customer_locations.update","customer_addresses.create","customer_addresses.update","suppliers.create","suppliers.update","supplier_ship_from_locations.create","supplier_ship_from_locations.update","products.create","products.update","products.archive","products.unarchive","product_packaging.create","products.suppliers.create","products.suppliers.delete","products.aliases.create","products.aliases.update","products.aliases.delete","product_families.aliases.create","product_families.aliases.update","product_families.aliases.delete","products.customer_part_numbers.create","products.customer_part_numbers.update","products.customer_part_numbers.delete","product_sds.update","product_documents.create","customer_documents.create","supplier_documents.create","purchase_order_documents.create","product_families.create","product_families.update","cost_book_entries.create","current_cost_sources.put","customers.archive","customers.unarchive","suppliers.archive","suppliers.unarchive","contacts.archive","contacts.unarchive","customer_addresses.archive","customer_addresses.unarchive","supplier_ship_from_locations.archive","supplier_ship_from_locations.unarchive","representatives.create","representatives.update","representatives.archive","representatives.unarchive","payment_terms.create","payment_terms.update","ledger_accounts.create","ledger_accounts.update"]},"status":{"type":"string","enum":["ready","blocked"]},"wouldWrite":{"type":"boolean","enum":[false]},"submit":{"type":"object","properties":{"method":{"type":"string","enum":["POST","PATCH","PUT","DELETE"]},"path":{"type":"string"},"query":{"type":"object","properties":{},"additionalProperties":false}},"required":["method","path","query"],"additionalProperties":false},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false},"checks":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["not_direct_ship","address_role_required","address_role_valid","already_assigned","already_exists","active_duplicate","ambiguous_external_id","ambiguous_natural_key","api_created","archived_target","archived_record","archive_blocked","account_type_locked","duplicate_candidate_found","duplicate_candidate_overflow","duplicate_check_clear","duplicate_check_not_needed","duplicate_contact","duplicate_customer","duplicate_customer_address","duplicate_customer_location","duplicate_note","duplicate_resolution_applied","duplicate_supplier","duplicate_supplier_ship_from_location","document_url_org_scoped","document_url_valid","upload_verified","sds_converged","idempotency_available","idempotency_key_required","idempotency_key_reused","idempotency_replay","idempotency_target_missing","income_statement_type_invalid","hard_identity_clear","nested_external_id_clear","commercial_references_valid","credit_denomination_mismatch","customer_service_representative_reference_active","ledger_account_reference_valid","payment_terms_reference_exists","sales_person_reference_active","supplier_representative_reference_active","duplicate_reference_identity","external_id_conflict","if_match_current","base_uom_transition_allowed","base_uom_transition_blocked","attribute_assignments_valid","attribute_assignments_invalid","selected_supplier_link","linked_records_available","natural_key_conflict","not_api_created","no_downstream_mutation","order_sensitive_update_allowed","order_sensitive_update_blocked","parent_available","cost_book_entry_blocked","cost_book_entry_valid","cost_book_reference_not_visible","unsupported_cost_book_uom","cost_uom_conversion_unavailable","cost_book_base_unavailable","cost_book_base_ambiguous","cost_ship_from_location_not_visible","cost_package_quantity_invalid","cost_component_invalid","cost_date_window_invalid","cost_date_overlap","cost_amount_overflow","cost_book_conflict","product_family_reference_active","product_packaging_reference_active","primary_child_available","primary_change_unsupported","reference_visibility_blocked","scope_authorized","stale_record","stale_cost_book_entry","supplier_reference_active","tag_applicable","tag_available","tag_exists","tag_found","tag_not_applicable","tag_not_found","type_immutable","type_known","type_required","target_active","target_available","target_not_found_or_not_visible","targets_visible","unsupported_linked_record","unsupported_profile_shape","variable_qty_valid","validation_failed","value_nonempty"]},"status":{"type":"string","enum":["passed","blocked"]},"message":{"type":"string"},"param":{"type":"string"}},"required":["code","status","message"],"additionalProperties":false}},"duplicateCandidates":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact","customer","supplier","customer_location","customer_address","supplier_ship_from_location","product","product_family","document"]},"readable":{"type":"boolean"},"version":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","product","purchase_order"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"matchReasons":{"type":"array","items":{"type":"string","enum":["name","email","externalId","address","code","product","url"]}},"readbackPath":{"type":"string"}},"required":["type","readable","matchReasons"],"additionalProperties":false}},"idempotency":{"type":"object","properties":{"required":{"type":"boolean"},"keyProvided":{"type":"boolean"},"wouldReplay":{"type":"boolean"}},"required":["required","keyProvided","wouldReplay"],"additionalProperties":false},"wouldChange":{"type":"object","properties":{"fieldNames":{"type":"array","items":{"type":"string"}},"values":{"type":"object","additionalProperties":{}}},"required":["fieldNames","values"],"additionalProperties":false},"impactAnalysis":{"type":"object","additionalProperties":{}},"requestId":{"type":"string"}},"required":["type","operation","status","wouldWrite","submit","verification","checks","duplicateCandidates","requestId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}]}}}},"201":{"description":"Product family alias created.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["product_alias"]},"id":{"type":"string","format":"uuid"},"value":{"type":"string"},"context":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["global"]}},"required":["type"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["customer"]},"customerId":{"type":"string","format":"uuid"}},"required":["type","customerId"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["supplier"]},"supplierId":{"type":"string","format":"uuid"}},"required":["type","supplierId"],"additionalProperties":false},{"type":"null"}]},"status":{"type":"string","enum":["resolved","unresolved","conflicting"]},"ownerUpdatedAt":{"type":"string","format":"date-time"},"idempotencyStatus":{"type":"string","enum":["created","replayed"]}},"required":["type","id","value","context","status","ownerUpdatedAt"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested parent or record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"409":{"description":"The write conflicted with an existing record, idempotency payload, or stale If-Match value.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/product-families/{id}/aliases/{aliasId}":{"patch":{"operationId":"updatePublicAPIProductFamilyAlias","summary":"Update a product family alias","description":"Updates the alias display value; the owner and context stay as created. Execute requests require If-Match. dryRun=true may omit If-Match and returns a blocked readiness check instead of writing.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"products:write","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"aliasId","in":"path"},{"schema":{"type":"string","enum":["true"]},"required":false,"name":"dryRun","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check."},"required":false,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check.","name":"If-Match","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"value":{"type":"string","minLength":1,"maxLength":240}},"required":["value"],"additionalProperties":false}}}},"responses":{"200":{"description":"Product family alias or dryRun readiness.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["product_alias"]},"id":{"type":"string","format":"uuid"},"value":{"type":"string"},"context":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["global"]}},"required":["type"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["customer"]},"customerId":{"type":"string","format":"uuid"}},"required":["type","customerId"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["supplier"]},"supplierId":{"type":"string","format":"uuid"}},"required":["type","supplierId"],"additionalProperties":false},{"type":"null"}]},"status":{"type":"string","enum":["resolved","unresolved","conflicting"]},"ownerUpdatedAt":{"type":"string","format":"date-time"},"idempotencyStatus":{"type":"string","enum":["created","replayed"]}},"required":["type","id","value","context","status","ownerUpdatedAt"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["write_readiness"]},"operation":{"type":"string","enum":["warehouses.create","warehouses.update","warehouses.archive","warehouses.unarchive","shipping_options.create","shipping_options.update","shipping_options.archive","shipping_options.unarchive","reorder_points.create","tags.create","tags.update","tag_assignments.create","tag_assignments.delete","notes.create","notes.update","opportunities.create","opportunities.update","opportunities.close","opportunities.meta-upsert","contacts.create","contacts.update","customers.create","customers.update","customer_locations.create","customer_locations.update","customer_addresses.create","customer_addresses.update","suppliers.create","suppliers.update","supplier_ship_from_locations.create","supplier_ship_from_locations.update","products.create","products.update","products.archive","products.unarchive","product_packaging.create","products.suppliers.create","products.suppliers.delete","products.aliases.create","products.aliases.update","products.aliases.delete","product_families.aliases.create","product_families.aliases.update","product_families.aliases.delete","products.customer_part_numbers.create","products.customer_part_numbers.update","products.customer_part_numbers.delete","product_sds.update","product_documents.create","customer_documents.create","supplier_documents.create","purchase_order_documents.create","product_families.create","product_families.update","cost_book_entries.create","current_cost_sources.put","customers.archive","customers.unarchive","suppliers.archive","suppliers.unarchive","contacts.archive","contacts.unarchive","customer_addresses.archive","customer_addresses.unarchive","supplier_ship_from_locations.archive","supplier_ship_from_locations.unarchive","representatives.create","representatives.update","representatives.archive","representatives.unarchive","payment_terms.create","payment_terms.update","ledger_accounts.create","ledger_accounts.update"]},"status":{"type":"string","enum":["ready","blocked"]},"wouldWrite":{"type":"boolean","enum":[false]},"submit":{"type":"object","properties":{"method":{"type":"string","enum":["POST","PATCH","PUT","DELETE"]},"path":{"type":"string"},"query":{"type":"object","properties":{},"additionalProperties":false}},"required":["method","path","query"],"additionalProperties":false},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false},"checks":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["not_direct_ship","address_role_required","address_role_valid","already_assigned","already_exists","active_duplicate","ambiguous_external_id","ambiguous_natural_key","api_created","archived_target","archived_record","archive_blocked","account_type_locked","duplicate_candidate_found","duplicate_candidate_overflow","duplicate_check_clear","duplicate_check_not_needed","duplicate_contact","duplicate_customer","duplicate_customer_address","duplicate_customer_location","duplicate_note","duplicate_resolution_applied","duplicate_supplier","duplicate_supplier_ship_from_location","document_url_org_scoped","document_url_valid","upload_verified","sds_converged","idempotency_available","idempotency_key_required","idempotency_key_reused","idempotency_replay","idempotency_target_missing","income_statement_type_invalid","hard_identity_clear","nested_external_id_clear","commercial_references_valid","credit_denomination_mismatch","customer_service_representative_reference_active","ledger_account_reference_valid","payment_terms_reference_exists","sales_person_reference_active","supplier_representative_reference_active","duplicate_reference_identity","external_id_conflict","if_match_current","base_uom_transition_allowed","base_uom_transition_blocked","attribute_assignments_valid","attribute_assignments_invalid","selected_supplier_link","linked_records_available","natural_key_conflict","not_api_created","no_downstream_mutation","order_sensitive_update_allowed","order_sensitive_update_blocked","parent_available","cost_book_entry_blocked","cost_book_entry_valid","cost_book_reference_not_visible","unsupported_cost_book_uom","cost_uom_conversion_unavailable","cost_book_base_unavailable","cost_book_base_ambiguous","cost_ship_from_location_not_visible","cost_package_quantity_invalid","cost_component_invalid","cost_date_window_invalid","cost_date_overlap","cost_amount_overflow","cost_book_conflict","product_family_reference_active","product_packaging_reference_active","primary_child_available","primary_change_unsupported","reference_visibility_blocked","scope_authorized","stale_record","stale_cost_book_entry","supplier_reference_active","tag_applicable","tag_available","tag_exists","tag_found","tag_not_applicable","tag_not_found","type_immutable","type_known","type_required","target_active","target_available","target_not_found_or_not_visible","targets_visible","unsupported_linked_record","unsupported_profile_shape","variable_qty_valid","validation_failed","value_nonempty"]},"status":{"type":"string","enum":["passed","blocked"]},"message":{"type":"string"},"param":{"type":"string"}},"required":["code","status","message"],"additionalProperties":false}},"duplicateCandidates":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact","customer","supplier","customer_location","customer_address","supplier_ship_from_location","product","product_family","document"]},"readable":{"type":"boolean"},"version":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","product","purchase_order"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"matchReasons":{"type":"array","items":{"type":"string","enum":["name","email","externalId","address","code","product","url"]}},"readbackPath":{"type":"string"}},"required":["type","readable","matchReasons"],"additionalProperties":false}},"idempotency":{"type":"object","properties":{"required":{"type":"boolean"},"keyProvided":{"type":"boolean"},"wouldReplay":{"type":"boolean"}},"required":["required","keyProvided","wouldReplay"],"additionalProperties":false},"wouldChange":{"type":"object","properties":{"fieldNames":{"type":"array","items":{"type":"string"}},"values":{"type":"object","additionalProperties":{}}},"required":["fieldNames","values"],"additionalProperties":false},"impactAnalysis":{"type":"object","additionalProperties":{}},"requestId":{"type":"string"}},"required":["type","operation","status","wouldWrite","submit","verification","checks","duplicateCandidates","requestId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}]}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested parent or record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"409":{"description":"The write conflicted with an existing record, idempotency payload, or stale If-Match value.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}},"delete":{"operationId":"removePublicAPIProductFamilyAlias","summary":"Remove a product family alias","description":"Removes the alias relationship. Execute requests require If-Match; dryRun=true may omit it and returns a blocked check when it is missing. After access, archive-state, and version checks pass, removing an alias that is not attached to the selected owner returns changed:false and leaves the owner timestamp unchanged.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"products:write","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"aliasId","in":"path"},{"schema":{"type":"string","enum":["true"]},"required":false,"name":"dryRun","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check."},"required":false,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check.","name":"If-Match","in":"header"}],"responses":{"200":{"description":"Product family alias receipt or dryRun readiness.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["product_alias_receipt"]},"id":{"type":"string","format":"uuid"},"changed":{"type":"boolean"},"ownerUpdatedAt":{"type":"string","format":"date-time"}},"required":["type","id","changed","ownerUpdatedAt"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["write_readiness"]},"operation":{"type":"string","enum":["warehouses.create","warehouses.update","warehouses.archive","warehouses.unarchive","shipping_options.create","shipping_options.update","shipping_options.archive","shipping_options.unarchive","reorder_points.create","tags.create","tags.update","tag_assignments.create","tag_assignments.delete","notes.create","notes.update","opportunities.create","opportunities.update","opportunities.close","opportunities.meta-upsert","contacts.create","contacts.update","customers.create","customers.update","customer_locations.create","customer_locations.update","customer_addresses.create","customer_addresses.update","suppliers.create","suppliers.update","supplier_ship_from_locations.create","supplier_ship_from_locations.update","products.create","products.update","products.archive","products.unarchive","product_packaging.create","products.suppliers.create","products.suppliers.delete","products.aliases.create","products.aliases.update","products.aliases.delete","product_families.aliases.create","product_families.aliases.update","product_families.aliases.delete","products.customer_part_numbers.create","products.customer_part_numbers.update","products.customer_part_numbers.delete","product_sds.update","product_documents.create","customer_documents.create","supplier_documents.create","purchase_order_documents.create","product_families.create","product_families.update","cost_book_entries.create","current_cost_sources.put","customers.archive","customers.unarchive","suppliers.archive","suppliers.unarchive","contacts.archive","contacts.unarchive","customer_addresses.archive","customer_addresses.unarchive","supplier_ship_from_locations.archive","supplier_ship_from_locations.unarchive","representatives.create","representatives.update","representatives.archive","representatives.unarchive","payment_terms.create","payment_terms.update","ledger_accounts.create","ledger_accounts.update"]},"status":{"type":"string","enum":["ready","blocked"]},"wouldWrite":{"type":"boolean","enum":[false]},"submit":{"type":"object","properties":{"method":{"type":"string","enum":["POST","PATCH","PUT","DELETE"]},"path":{"type":"string"},"query":{"type":"object","properties":{},"additionalProperties":false}},"required":["method","path","query"],"additionalProperties":false},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false},"checks":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["not_direct_ship","address_role_required","address_role_valid","already_assigned","already_exists","active_duplicate","ambiguous_external_id","ambiguous_natural_key","api_created","archived_target","archived_record","archive_blocked","account_type_locked","duplicate_candidate_found","duplicate_candidate_overflow","duplicate_check_clear","duplicate_check_not_needed","duplicate_contact","duplicate_customer","duplicate_customer_address","duplicate_customer_location","duplicate_note","duplicate_resolution_applied","duplicate_supplier","duplicate_supplier_ship_from_location","document_url_org_scoped","document_url_valid","upload_verified","sds_converged","idempotency_available","idempotency_key_required","idempotency_key_reused","idempotency_replay","idempotency_target_missing","income_statement_type_invalid","hard_identity_clear","nested_external_id_clear","commercial_references_valid","credit_denomination_mismatch","customer_service_representative_reference_active","ledger_account_reference_valid","payment_terms_reference_exists","sales_person_reference_active","supplier_representative_reference_active","duplicate_reference_identity","external_id_conflict","if_match_current","base_uom_transition_allowed","base_uom_transition_blocked","attribute_assignments_valid","attribute_assignments_invalid","selected_supplier_link","linked_records_available","natural_key_conflict","not_api_created","no_downstream_mutation","order_sensitive_update_allowed","order_sensitive_update_blocked","parent_available","cost_book_entry_blocked","cost_book_entry_valid","cost_book_reference_not_visible","unsupported_cost_book_uom","cost_uom_conversion_unavailable","cost_book_base_unavailable","cost_book_base_ambiguous","cost_ship_from_location_not_visible","cost_package_quantity_invalid","cost_component_invalid","cost_date_window_invalid","cost_date_overlap","cost_amount_overflow","cost_book_conflict","product_family_reference_active","product_packaging_reference_active","primary_child_available","primary_change_unsupported","reference_visibility_blocked","scope_authorized","stale_record","stale_cost_book_entry","supplier_reference_active","tag_applicable","tag_available","tag_exists","tag_found","tag_not_applicable","tag_not_found","type_immutable","type_known","type_required","target_active","target_available","target_not_found_or_not_visible","targets_visible","unsupported_linked_record","unsupported_profile_shape","variable_qty_valid","validation_failed","value_nonempty"]},"status":{"type":"string","enum":["passed","blocked"]},"message":{"type":"string"},"param":{"type":"string"}},"required":["code","status","message"],"additionalProperties":false}},"duplicateCandidates":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact","customer","supplier","customer_location","customer_address","supplier_ship_from_location","product","product_family","document"]},"readable":{"type":"boolean"},"version":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","product","purchase_order"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"matchReasons":{"type":"array","items":{"type":"string","enum":["name","email","externalId","address","code","product","url"]}},"readbackPath":{"type":"string"}},"required":["type","readable","matchReasons"],"additionalProperties":false}},"idempotency":{"type":"object","properties":{"required":{"type":"boolean"},"keyProvided":{"type":"boolean"},"wouldReplay":{"type":"boolean"}},"required":["required","keyProvided","wouldReplay"],"additionalProperties":false},"wouldChange":{"type":"object","properties":{"fieldNames":{"type":"array","items":{"type":"string"}},"values":{"type":"object","additionalProperties":{}}},"required":["fieldNames","values"],"additionalProperties":false},"impactAnalysis":{"type":"object","additionalProperties":{}},"requestId":{"type":"string"}},"required":["type","operation","status","wouldWrite","submit","verification","checks","duplicateCandidates","requestId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}]}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested parent or record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"409":{"description":"The write conflicted with an existing record, idempotency payload, or stale If-Match value.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/products/{id}/customer-part-numbers":{"get":{"operationId":"listPublicAPIProductCustomerPartNumbers","summary":"List product customer part numbers","description":"Returns customer part numbers for customers available to the acting person.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"products:read","x-required-scopes-all":["products:read","customers:read"],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string"},"required":false,"name":"limit","in":"query"},{"schema":{"type":"string"},"required":false,"name":"cursor","in":"query"}],"responses":{"200":{"description":"Product customer part-number page.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["product_customer_part_number"]},"id":{"type":"string","format":"uuid"},"productId":{"type":"string","format":"uuid"},"customer":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"externalId":{"type":["string","null"]}},"required":["id","name","externalId"],"additionalProperties":false},"partNo":{"type":"string"}},"required":["type","id","productId","customer","partNo"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["product_customer_part_number"]},"id":{"type":"string","format":"uuid"},"productId":{"type":"string","format":"uuid"},"customerId":{"type":"string","format":"uuid"},"partNo":{"type":"string"},"changed":{"type":"boolean"},"ownerUpdatedAt":{"type":"string","format":"date-time"}},"required":["type","id","productId","customerId","partNo","changed","ownerUpdatedAt"],"additionalProperties":false}]}},"meta":{"type":"object","properties":{"limit":{"type":"integer","exclusiveMinimum":0},"returnedRecords":{"type":"integer","minimum":0},"hasMore":{"type":"boolean"},"truncated":{"type":"boolean"},"nextCursor":{"type":["string","null"]},"requestId":{"type":"string"},"ownerUpdatedAt":{"type":"string","format":"date-time"}},"required":["limit","returnedRecords","hasMore","truncated","nextCursor","requestId"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}},"post":{"operationId":"createPublicAPIProductCustomerPartNumber","summary":"Create a product customer part number","description":"Creates or confirms one customer part number for the selected product. Execute requests require If-Match. dryRun=true may omit If-Match and returns a blocked readiness check instead of writing. Exact repeats are unchanged; a different value requires PATCH.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"products:write","x-required-scopes-all":["products:write","customers:read"],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","enum":["true"]},"required":false,"name":"dryRun","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check."},"required":false,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check.","name":"If-Match","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"customerId":{"type":"string","format":"uuid"},"partNo":{"type":"string","minLength":1,"maxLength":240}},"required":["customerId","partNo"],"additionalProperties":false}}}},"responses":{"200":{"description":"Product customer part number or dryRun readiness.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"data":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["product_customer_part_number"]},"id":{"type":"string","format":"uuid"},"productId":{"type":"string","format":"uuid"},"customer":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"externalId":{"type":["string","null"]}},"required":["id","name","externalId"],"additionalProperties":false},"partNo":{"type":"string"}},"required":["type","id","productId","customer","partNo"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["product_customer_part_number"]},"id":{"type":"string","format":"uuid"},"productId":{"type":"string","format":"uuid"},"customerId":{"type":"string","format":"uuid"},"partNo":{"type":"string"},"changed":{"type":"boolean"},"ownerUpdatedAt":{"type":"string","format":"date-time"}},"required":["type","id","productId","customerId","partNo","changed","ownerUpdatedAt"],"additionalProperties":false}]}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["write_readiness"]},"operation":{"type":"string","enum":["warehouses.create","warehouses.update","warehouses.archive","warehouses.unarchive","shipping_options.create","shipping_options.update","shipping_options.archive","shipping_options.unarchive","reorder_points.create","tags.create","tags.update","tag_assignments.create","tag_assignments.delete","notes.create","notes.update","opportunities.create","opportunities.update","opportunities.close","opportunities.meta-upsert","contacts.create","contacts.update","customers.create","customers.update","customer_locations.create","customer_locations.update","customer_addresses.create","customer_addresses.update","suppliers.create","suppliers.update","supplier_ship_from_locations.create","supplier_ship_from_locations.update","products.create","products.update","products.archive","products.unarchive","product_packaging.create","products.suppliers.create","products.suppliers.delete","products.aliases.create","products.aliases.update","products.aliases.delete","product_families.aliases.create","product_families.aliases.update","product_families.aliases.delete","products.customer_part_numbers.create","products.customer_part_numbers.update","products.customer_part_numbers.delete","product_sds.update","product_documents.create","customer_documents.create","supplier_documents.create","purchase_order_documents.create","product_families.create","product_families.update","cost_book_entries.create","current_cost_sources.put","customers.archive","customers.unarchive","suppliers.archive","suppliers.unarchive","contacts.archive","contacts.unarchive","customer_addresses.archive","customer_addresses.unarchive","supplier_ship_from_locations.archive","supplier_ship_from_locations.unarchive","representatives.create","representatives.update","representatives.archive","representatives.unarchive","payment_terms.create","payment_terms.update","ledger_accounts.create","ledger_accounts.update"]},"status":{"type":"string","enum":["ready","blocked"]},"wouldWrite":{"type":"boolean","enum":[false]},"submit":{"type":"object","properties":{"method":{"type":"string","enum":["POST","PATCH","PUT","DELETE"]},"path":{"type":"string"},"query":{"type":"object","properties":{},"additionalProperties":false}},"required":["method","path","query"],"additionalProperties":false},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false},"checks":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["not_direct_ship","address_role_required","address_role_valid","already_assigned","already_exists","active_duplicate","ambiguous_external_id","ambiguous_natural_key","api_created","archived_target","archived_record","archive_blocked","account_type_locked","duplicate_candidate_found","duplicate_candidate_overflow","duplicate_check_clear","duplicate_check_not_needed","duplicate_contact","duplicate_customer","duplicate_customer_address","duplicate_customer_location","duplicate_note","duplicate_resolution_applied","duplicate_supplier","duplicate_supplier_ship_from_location","document_url_org_scoped","document_url_valid","upload_verified","sds_converged","idempotency_available","idempotency_key_required","idempotency_key_reused","idempotency_replay","idempotency_target_missing","income_statement_type_invalid","hard_identity_clear","nested_external_id_clear","commercial_references_valid","credit_denomination_mismatch","customer_service_representative_reference_active","ledger_account_reference_valid","payment_terms_reference_exists","sales_person_reference_active","supplier_representative_reference_active","duplicate_reference_identity","external_id_conflict","if_match_current","base_uom_transition_allowed","base_uom_transition_blocked","attribute_assignments_valid","attribute_assignments_invalid","selected_supplier_link","linked_records_available","natural_key_conflict","not_api_created","no_downstream_mutation","order_sensitive_update_allowed","order_sensitive_update_blocked","parent_available","cost_book_entry_blocked","cost_book_entry_valid","cost_book_reference_not_visible","unsupported_cost_book_uom","cost_uom_conversion_unavailable","cost_book_base_unavailable","cost_book_base_ambiguous","cost_ship_from_location_not_visible","cost_package_quantity_invalid","cost_component_invalid","cost_date_window_invalid","cost_date_overlap","cost_amount_overflow","cost_book_conflict","product_family_reference_active","product_packaging_reference_active","primary_child_available","primary_change_unsupported","reference_visibility_blocked","scope_authorized","stale_record","stale_cost_book_entry","supplier_reference_active","tag_applicable","tag_available","tag_exists","tag_found","tag_not_applicable","tag_not_found","type_immutable","type_known","type_required","target_active","target_available","target_not_found_or_not_visible","targets_visible","unsupported_linked_record","unsupported_profile_shape","variable_qty_valid","validation_failed","value_nonempty"]},"status":{"type":"string","enum":["passed","blocked"]},"message":{"type":"string"},"param":{"type":"string"}},"required":["code","status","message"],"additionalProperties":false}},"duplicateCandidates":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact","customer","supplier","customer_location","customer_address","supplier_ship_from_location","product","product_family","document"]},"readable":{"type":"boolean"},"version":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","product","purchase_order"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"matchReasons":{"type":"array","items":{"type":"string","enum":["name","email","externalId","address","code","product","url"]}},"readbackPath":{"type":"string"}},"required":["type","readable","matchReasons"],"additionalProperties":false}},"idempotency":{"type":"object","properties":{"required":{"type":"boolean"},"keyProvided":{"type":"boolean"},"wouldReplay":{"type":"boolean"}},"required":["required","keyProvided","wouldReplay"],"additionalProperties":false},"wouldChange":{"type":"object","properties":{"fieldNames":{"type":"array","items":{"type":"string"}},"values":{"type":"object","additionalProperties":{}}},"required":["fieldNames","values"],"additionalProperties":false},"impactAnalysis":{"type":"object","additionalProperties":{}},"requestId":{"type":"string"}},"required":["type","operation","status","wouldWrite","submit","verification","checks","duplicateCandidates","requestId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}]}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested parent or record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"409":{"description":"The write conflicted with an existing record, idempotency payload, or stale If-Match value.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/products/{id}/customer-part-numbers/{customerId}":{"patch":{"operationId":"updatePublicAPIProductCustomerPartNumber","summary":"Update a product customer part number","description":"Updates the part number for the exact customer relationship. Execute requests require If-Match. dryRun=true may omit If-Match and returns a blocked readiness check instead of writing.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"products:write","x-required-scopes-all":["products:write","customers:read"],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"customerId","in":"path"},{"schema":{"type":"string","enum":["true"]},"required":false,"name":"dryRun","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check."},"required":false,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check.","name":"If-Match","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"partNo":{"type":"string","minLength":1,"maxLength":240}},"required":["partNo"],"additionalProperties":false}}}},"responses":{"200":{"description":"Product customer part number or dryRun readiness.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"data":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["product_customer_part_number"]},"id":{"type":"string","format":"uuid"},"productId":{"type":"string","format":"uuid"},"customer":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"externalId":{"type":["string","null"]}},"required":["id","name","externalId"],"additionalProperties":false},"partNo":{"type":"string"}},"required":["type","id","productId","customer","partNo"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["product_customer_part_number"]},"id":{"type":"string","format":"uuid"},"productId":{"type":"string","format":"uuid"},"customerId":{"type":"string","format":"uuid"},"partNo":{"type":"string"},"changed":{"type":"boolean"},"ownerUpdatedAt":{"type":"string","format":"date-time"}},"required":["type","id","productId","customerId","partNo","changed","ownerUpdatedAt"],"additionalProperties":false}]}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["write_readiness"]},"operation":{"type":"string","enum":["warehouses.create","warehouses.update","warehouses.archive","warehouses.unarchive","shipping_options.create","shipping_options.update","shipping_options.archive","shipping_options.unarchive","reorder_points.create","tags.create","tags.update","tag_assignments.create","tag_assignments.delete","notes.create","notes.update","opportunities.create","opportunities.update","opportunities.close","opportunities.meta-upsert","contacts.create","contacts.update","customers.create","customers.update","customer_locations.create","customer_locations.update","customer_addresses.create","customer_addresses.update","suppliers.create","suppliers.update","supplier_ship_from_locations.create","supplier_ship_from_locations.update","products.create","products.update","products.archive","products.unarchive","product_packaging.create","products.suppliers.create","products.suppliers.delete","products.aliases.create","products.aliases.update","products.aliases.delete","product_families.aliases.create","product_families.aliases.update","product_families.aliases.delete","products.customer_part_numbers.create","products.customer_part_numbers.update","products.customer_part_numbers.delete","product_sds.update","product_documents.create","customer_documents.create","supplier_documents.create","purchase_order_documents.create","product_families.create","product_families.update","cost_book_entries.create","current_cost_sources.put","customers.archive","customers.unarchive","suppliers.archive","suppliers.unarchive","contacts.archive","contacts.unarchive","customer_addresses.archive","customer_addresses.unarchive","supplier_ship_from_locations.archive","supplier_ship_from_locations.unarchive","representatives.create","representatives.update","representatives.archive","representatives.unarchive","payment_terms.create","payment_terms.update","ledger_accounts.create","ledger_accounts.update"]},"status":{"type":"string","enum":["ready","blocked"]},"wouldWrite":{"type":"boolean","enum":[false]},"submit":{"type":"object","properties":{"method":{"type":"string","enum":["POST","PATCH","PUT","DELETE"]},"path":{"type":"string"},"query":{"type":"object","properties":{},"additionalProperties":false}},"required":["method","path","query"],"additionalProperties":false},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false},"checks":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["not_direct_ship","address_role_required","address_role_valid","already_assigned","already_exists","active_duplicate","ambiguous_external_id","ambiguous_natural_key","api_created","archived_target","archived_record","archive_blocked","account_type_locked","duplicate_candidate_found","duplicate_candidate_overflow","duplicate_check_clear","duplicate_check_not_needed","duplicate_contact","duplicate_customer","duplicate_customer_address","duplicate_customer_location","duplicate_note","duplicate_resolution_applied","duplicate_supplier","duplicate_supplier_ship_from_location","document_url_org_scoped","document_url_valid","upload_verified","sds_converged","idempotency_available","idempotency_key_required","idempotency_key_reused","idempotency_replay","idempotency_target_missing","income_statement_type_invalid","hard_identity_clear","nested_external_id_clear","commercial_references_valid","credit_denomination_mismatch","customer_service_representative_reference_active","ledger_account_reference_valid","payment_terms_reference_exists","sales_person_reference_active","supplier_representative_reference_active","duplicate_reference_identity","external_id_conflict","if_match_current","base_uom_transition_allowed","base_uom_transition_blocked","attribute_assignments_valid","attribute_assignments_invalid","selected_supplier_link","linked_records_available","natural_key_conflict","not_api_created","no_downstream_mutation","order_sensitive_update_allowed","order_sensitive_update_blocked","parent_available","cost_book_entry_blocked","cost_book_entry_valid","cost_book_reference_not_visible","unsupported_cost_book_uom","cost_uom_conversion_unavailable","cost_book_base_unavailable","cost_book_base_ambiguous","cost_ship_from_location_not_visible","cost_package_quantity_invalid","cost_component_invalid","cost_date_window_invalid","cost_date_overlap","cost_amount_overflow","cost_book_conflict","product_family_reference_active","product_packaging_reference_active","primary_child_available","primary_change_unsupported","reference_visibility_blocked","scope_authorized","stale_record","stale_cost_book_entry","supplier_reference_active","tag_applicable","tag_available","tag_exists","tag_found","tag_not_applicable","tag_not_found","type_immutable","type_known","type_required","target_active","target_available","target_not_found_or_not_visible","targets_visible","unsupported_linked_record","unsupported_profile_shape","variable_qty_valid","validation_failed","value_nonempty"]},"status":{"type":"string","enum":["passed","blocked"]},"message":{"type":"string"},"param":{"type":"string"}},"required":["code","status","message"],"additionalProperties":false}},"duplicateCandidates":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact","customer","supplier","customer_location","customer_address","supplier_ship_from_location","product","product_family","document"]},"readable":{"type":"boolean"},"version":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","product","purchase_order"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"matchReasons":{"type":"array","items":{"type":"string","enum":["name","email","externalId","address","code","product","url"]}},"readbackPath":{"type":"string"}},"required":["type","readable","matchReasons"],"additionalProperties":false}},"idempotency":{"type":"object","properties":{"required":{"type":"boolean"},"keyProvided":{"type":"boolean"},"wouldReplay":{"type":"boolean"}},"required":["required","keyProvided","wouldReplay"],"additionalProperties":false},"wouldChange":{"type":"object","properties":{"fieldNames":{"type":"array","items":{"type":"string"}},"values":{"type":"object","additionalProperties":{}}},"required":["fieldNames","values"],"additionalProperties":false},"impactAnalysis":{"type":"object","additionalProperties":{}},"requestId":{"type":"string"}},"required":["type","operation","status","wouldWrite","submit","verification","checks","duplicateCandidates","requestId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}]}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested parent or record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"409":{"description":"The write conflicted with an existing record, idempotency payload, or stale If-Match value.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}},"delete":{"operationId":"removePublicAPIProductCustomerPartNumber","summary":"Remove a product customer part number","description":"Removes the selected customer part number. Execute requests require If-Match. dryRun=true may omit If-Match and returns a blocked readiness check instead of writing.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"products:write","x-required-scopes-all":["products:write","customers:read"],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"customerId","in":"path"},{"schema":{"type":"string","enum":["true"]},"required":false,"name":"dryRun","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check."},"required":false,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check.","name":"If-Match","in":"header"}],"responses":{"200":{"description":"Product customer part-number receipt or dryRun readiness.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["product_customer_part_number_receipt"]},"productId":{"type":"string","format":"uuid"},"customerId":{"type":"string","format":"uuid"},"changed":{"type":"boolean"},"ownerUpdatedAt":{"type":"string","format":"date-time"}},"required":["type","productId","customerId","changed","ownerUpdatedAt"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["write_readiness"]},"operation":{"type":"string","enum":["warehouses.create","warehouses.update","warehouses.archive","warehouses.unarchive","shipping_options.create","shipping_options.update","shipping_options.archive","shipping_options.unarchive","reorder_points.create","tags.create","tags.update","tag_assignments.create","tag_assignments.delete","notes.create","notes.update","opportunities.create","opportunities.update","opportunities.close","opportunities.meta-upsert","contacts.create","contacts.update","customers.create","customers.update","customer_locations.create","customer_locations.update","customer_addresses.create","customer_addresses.update","suppliers.create","suppliers.update","supplier_ship_from_locations.create","supplier_ship_from_locations.update","products.create","products.update","products.archive","products.unarchive","product_packaging.create","products.suppliers.create","products.suppliers.delete","products.aliases.create","products.aliases.update","products.aliases.delete","product_families.aliases.create","product_families.aliases.update","product_families.aliases.delete","products.customer_part_numbers.create","products.customer_part_numbers.update","products.customer_part_numbers.delete","product_sds.update","product_documents.create","customer_documents.create","supplier_documents.create","purchase_order_documents.create","product_families.create","product_families.update","cost_book_entries.create","current_cost_sources.put","customers.archive","customers.unarchive","suppliers.archive","suppliers.unarchive","contacts.archive","contacts.unarchive","customer_addresses.archive","customer_addresses.unarchive","supplier_ship_from_locations.archive","supplier_ship_from_locations.unarchive","representatives.create","representatives.update","representatives.archive","representatives.unarchive","payment_terms.create","payment_terms.update","ledger_accounts.create","ledger_accounts.update"]},"status":{"type":"string","enum":["ready","blocked"]},"wouldWrite":{"type":"boolean","enum":[false]},"submit":{"type":"object","properties":{"method":{"type":"string","enum":["POST","PATCH","PUT","DELETE"]},"path":{"type":"string"},"query":{"type":"object","properties":{},"additionalProperties":false}},"required":["method","path","query"],"additionalProperties":false},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false},"checks":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["not_direct_ship","address_role_required","address_role_valid","already_assigned","already_exists","active_duplicate","ambiguous_external_id","ambiguous_natural_key","api_created","archived_target","archived_record","archive_blocked","account_type_locked","duplicate_candidate_found","duplicate_candidate_overflow","duplicate_check_clear","duplicate_check_not_needed","duplicate_contact","duplicate_customer","duplicate_customer_address","duplicate_customer_location","duplicate_note","duplicate_resolution_applied","duplicate_supplier","duplicate_supplier_ship_from_location","document_url_org_scoped","document_url_valid","upload_verified","sds_converged","idempotency_available","idempotency_key_required","idempotency_key_reused","idempotency_replay","idempotency_target_missing","income_statement_type_invalid","hard_identity_clear","nested_external_id_clear","commercial_references_valid","credit_denomination_mismatch","customer_service_representative_reference_active","ledger_account_reference_valid","payment_terms_reference_exists","sales_person_reference_active","supplier_representative_reference_active","duplicate_reference_identity","external_id_conflict","if_match_current","base_uom_transition_allowed","base_uom_transition_blocked","attribute_assignments_valid","attribute_assignments_invalid","selected_supplier_link","linked_records_available","natural_key_conflict","not_api_created","no_downstream_mutation","order_sensitive_update_allowed","order_sensitive_update_blocked","parent_available","cost_book_entry_blocked","cost_book_entry_valid","cost_book_reference_not_visible","unsupported_cost_book_uom","cost_uom_conversion_unavailable","cost_book_base_unavailable","cost_book_base_ambiguous","cost_ship_from_location_not_visible","cost_package_quantity_invalid","cost_component_invalid","cost_date_window_invalid","cost_date_overlap","cost_amount_overflow","cost_book_conflict","product_family_reference_active","product_packaging_reference_active","primary_child_available","primary_change_unsupported","reference_visibility_blocked","scope_authorized","stale_record","stale_cost_book_entry","supplier_reference_active","tag_applicable","tag_available","tag_exists","tag_found","tag_not_applicable","tag_not_found","type_immutable","type_known","type_required","target_active","target_available","target_not_found_or_not_visible","targets_visible","unsupported_linked_record","unsupported_profile_shape","variable_qty_valid","validation_failed","value_nonempty"]},"status":{"type":"string","enum":["passed","blocked"]},"message":{"type":"string"},"param":{"type":"string"}},"required":["code","status","message"],"additionalProperties":false}},"duplicateCandidates":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact","customer","supplier","customer_location","customer_address","supplier_ship_from_location","product","product_family","document"]},"readable":{"type":"boolean"},"version":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","product","purchase_order"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"matchReasons":{"type":"array","items":{"type":"string","enum":["name","email","externalId","address","code","product","url"]}},"readbackPath":{"type":"string"}},"required":["type","readable","matchReasons"],"additionalProperties":false}},"idempotency":{"type":"object","properties":{"required":{"type":"boolean"},"keyProvided":{"type":"boolean"},"wouldReplay":{"type":"boolean"}},"required":["required","keyProvided","wouldReplay"],"additionalProperties":false},"wouldChange":{"type":"object","properties":{"fieldNames":{"type":"array","items":{"type":"string"}},"values":{"type":"object","additionalProperties":{}}},"required":["fieldNames","values"],"additionalProperties":false},"impactAnalysis":{"type":"object","additionalProperties":{}},"requestId":{"type":"string"}},"required":["type","operation","status","wouldWrite","submit","verification","checks","duplicateCandidates","requestId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}]}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested parent or record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"409":{"description":"The write conflicted with an existing record, idempotency payload, or stale If-Match value.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/products":{"get":{"operationId":"findPublicAPIProducts","summary":"Find products","description":"Bounded product finder. Requires q, exact code, exact externalId, or supplierId. Pass finder inputs only as URL query parameters; do not send a request body.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"products:read","parameters":[{"schema":{"type":"string"},"required":false,"name":"q","in":"query"},{"schema":{"type":"string"},"required":false,"name":"code","in":"query"},{"schema":{"type":"string"},"required":false,"name":"externalId","in":"query"},{"schema":{"type":"string","format":"uuid"},"required":false,"name":"supplierId","in":"query"},{"schema":{"type":"string"},"required":false,"name":"limit","in":"query"},{"schema":{"type":"string"},"required":false,"name":"includeArchived","in":"query"}],"responses":{"200":{"description":"Product finder summaries.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["product"]},"id":{"type":"string","format":"uuid"},"code":{"type":"string"},"displayName":{"type":"string"},"productFamily":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false},"supplier":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"externalId":{"type":["string","null"]},"archived":{"type":"boolean"}},"required":["id","displayName","externalId","archived"],"additionalProperties":false},"packaging":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"unitOfMeasure":{"type":"string"}},"required":["id","name","unitOfMeasure"],"additionalProperties":false},"packagingType":{"type":["string","null"]},"hazmat":{"type":"object","properties":{"unNumber":{"type":["string","null"]},"properShippingName":{"type":["string","null"]},"hazardClass":{"type":"array","items":{"type":"string"}}},"required":["unNumber","properShippingName","hazardClass"],"additionalProperties":false},"url":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"},"archived":{"type":"boolean"}},"required":["type","id","code","displayName","productFamily","supplier","packaging","packagingType","hazmat","url","updatedAt","archived"],"additionalProperties":false}},"meta":{"type":"object","properties":{"requestId":{"type":"string"},"mode":{"type":"string"},"limit":{"type":"integer"},"hasMore":{"type":"boolean"},"filters":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"changedRecordBasis":{"type":"string","enum":["parent_updated_at"]},"narrowingHints":{"type":"array","items":{"type":"string"}}},"required":["requestId","mode","limit","hasMore","filters"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Product finder validation failed.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false},"examples":{"finder-filter-required":{"summary":"The product finder was called without a narrowing filter","value":{"error":{"type":"validation_error","code":"finder_filter_required","message":"Product finder requires a narrowing filter.","narrowingHints":["Add q, exact code, exact externalId, or supplierId."],"doNotRetrySameRequest":true,"suggestedAction":"add_required_filter","documentationPath":"/api/v1/openapi.json","repairCategory":"missing_required_filter","requestId":"req-example"}}},"invalid-limit":{"summary":"The product finder limit is outside the supported range","value":{"error":{"type":"validation_error","code":"validation_failed","message":"Request validation failed.","param":"limit","errors":[{"path":"limit","message":"Number must be less than or equal to 50"}],"requestId":"req-example"}}}}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}},"post":{"operationId":"createPublicAPIProduct","summary":"Create a product","description":"Creates a bounded product catalog record from existing product family, packaging, and optional supplier references. Execute requests require Idempotency-Key. dryRun=true may omit Idempotency-Key and returns a blocked readiness check instead of writing. Product writes are bounded by products:write, live ProductPermission checks, dry-run readiness, idempotency, duplicate checks, and readback verification. They never create packaging, suppliers, documents, inventory, costs, prices, orders, lots, or accounting records.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"products:write","parameters":[{"schema":{"type":"string","enum":["true"]},"required":false,"name":"dryRun","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Required for execute requests. dryRun=true may omit this header and receive an idempotency_key_required check."},"required":false,"description":"Required for execute requests. dryRun=true may omit this header and receive an idempotency_key_required check.","name":"Idempotency-Key","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","minLength":1,"maxLength":120},"externalId":{"type":["string","null"],"maxLength":120},"productFamilyId":{"type":"string","format":"uuid"},"packagingId":{"type":"string","format":"uuid"},"supplierId":{"type":["string","null"],"format":"uuid"},"packagingType":{"type":"string","enum":["FIXED","VARIABLE"],"default":"FIXED"},"supplierType":{"type":"string","enum":["FIXED","VARIABLE"],"default":"VARIABLE"},"qty":{"anyOf":[{"type":"string"},{"type":"number"}]},"casNumber":{"type":["string","null"],"maxLength":80},"ghsSignalWord":{"type":["string","null"],"enum":["DANGER","WARNING"]},"freightClass":{"type":["string","null"],"maxLength":40},"nmfcCode":{"type":["string","null"],"maxLength":20},"netUnitWeightLbs":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"null"}]},"unNumber":{"type":["string","null"],"maxLength":20},"properShippingName":{"type":["string","null"],"maxLength":240},"hazardClass":{"type":"array","items":{"type":"string","minLength":1,"maxLength":40},"default":[]},"packingGroup":{"type":["string","null"],"maxLength":20},"specialDesignation":{"type":["string","null"],"maxLength":120},"packagesPerPallet":{"type":["integer","null"],"minimum":0},"hazardSymbols":{"type":"array","items":{"type":"string","minLength":1,"maxLength":80},"default":[]},"attributeAssignments":{"type":"array","items":{"type":"object","properties":{"attributeId":{"type":"string","format":"uuid"},"optionIds":{"type":"array","items":{"type":"string","format":"uuid"}},"textValue":{"type":["string","null"],"maxLength":500},"booleanValue":{"type":["boolean","null"]}},"required":["attributeId"],"additionalProperties":false},"default":[]}},"required":["code","productFamilyId","packagingId","qty"],"additionalProperties":false}}}},"responses":{"200":{"description":"Idempotent replay returned the existing product, or dryRun returned write readiness.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["product"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"url":{"type":"string"},"archived":{"type":"boolean"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"code":{"type":"string"},"externalId":{"type":["string","null"]},"casNumber":{"type":["string","null"]},"ghsSignalWord":{"type":["string","null"]},"qty":{"type":["string","null"]},"packagingType":{"type":["string","null"],"enum":["FIXED","VARIABLE"]},"supplierType":{"type":["string","null"],"enum":["FIXED","VARIABLE"]},"freightClass":{"type":["string","null"]},"nmfcCode":{"type":["string","null"]},"netUnitWeightLbs":{"type":["string","null"]},"packagesPerPallet":{"type":["integer","null"]},"productFamily":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"casNumber":{"type":["string","null"]},"molecularFormula":{"type":["string","null"]},"unNumbers":{"type":"array","items":{"type":"string"}},"ghsSignalWord":{"type":["string","null"]},"hazardSymbols":{"type":"array","items":{"type":"string"}}},"required":["id","name","casNumber","molecularFormula","unNumbers","ghsSignalWord","hazardSymbols"],"additionalProperties":false},"supplier":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"archived":{"type":"boolean"}},"required":["id","displayName","archived"],"additionalProperties":false},"packaging":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"unitOfMeasure":{"type":"string"},"isBulk":{"type":"boolean"},"tareWeightLbs":{"type":["string","null"]},"capacity":{"type":["string","null"]},"material":{"type":["string","null"]},"unSpecCode":{"type":["string","null"]},"maxGrossWeightLbs":{"type":["string","null"]}},"required":["id","name","unitOfMeasure","isBulk","tareWeightLbs","capacity","material","unSpecCode","maxGrossWeightLbs"],"additionalProperties":false},"hazmat":{"type":"object","properties":{"unNumber":{"type":["string","null"]},"properShippingName":{"type":["string","null"]},"hazardClass":{"type":"array","items":{"type":"string"}},"packingGroup":{"type":["string","null"]},"specialDesignation":{"type":["string","null"]},"hazardSymbols":{"type":"array","items":{"type":"string"}}},"required":["unNumber","properShippingName","hazardClass","packingGroup","specialDesignation","hazardSymbols"],"additionalProperties":false},"catalog":{"type":"object","properties":{"family":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"externalId":{"type":["string","null"]}},"required":["id","externalId"],"additionalProperties":false},"packaging":{"type":"object","properties":{"id":{"type":"string","format":"uuid"}},"required":["id"],"additionalProperties":false},"archived":{"type":"boolean"},"links":{"type":"object","properties":{"attributeAssignments":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":"string"}},"required":["available","method","path"],"additionalProperties":false},"suppliers":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":"string"}},"required":["available","method","path"],"additionalProperties":false},"aliases":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":"string"}},"required":["available","method","path"],"additionalProperties":false},"customerPartNumbers":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":"string"}},"required":["available","method","path"],"additionalProperties":false}},"required":["attributeAssignments","suppliers","aliases","customerPartNumbers"],"additionalProperties":false}},"required":["family","packaging","archived","links"],"additionalProperties":false},"idempotencyStatus":{"type":"string","enum":["created","replayed"]},"attributeAssignments":{"type":"array","items":{"type":"object","properties":{"attributeId":{"type":"string","format":"uuid"},"optionIds":{"type":"array","items":{"type":"string","format":"uuid"}},"textValue":{"type":["string","null"],"maxLength":500},"booleanValue":{"type":["boolean","null"]}},"required":["attributeId"],"additionalProperties":false},"description":"The normalized assignment set accepted by this create or explicit PATCH replacement. Omitted when PATCH did not submit assignments; replay repeats the accepted request set, not a read of current stored assignments."}},"required":["type","id","displayName","url","archived","createdAt","updatedAt","code","externalId","casNumber","ghsSignalWord","qty","packagingType","supplierType","freightClass","nmfcCode","netUnitWeightLbs","packagesPerPallet","productFamily","supplier","packaging","hazmat","catalog"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["write_readiness"]},"operation":{"type":"string","enum":["warehouses.create","warehouses.update","warehouses.archive","warehouses.unarchive","shipping_options.create","shipping_options.update","shipping_options.archive","shipping_options.unarchive","reorder_points.create","tags.create","tags.update","tag_assignments.create","tag_assignments.delete","notes.create","notes.update","opportunities.create","opportunities.update","opportunities.close","opportunities.meta-upsert","contacts.create","contacts.update","customers.create","customers.update","customer_locations.create","customer_locations.update","customer_addresses.create","customer_addresses.update","suppliers.create","suppliers.update","supplier_ship_from_locations.create","supplier_ship_from_locations.update","products.create","products.update","products.archive","products.unarchive","product_packaging.create","products.suppliers.create","products.suppliers.delete","products.aliases.create","products.aliases.update","products.aliases.delete","product_families.aliases.create","product_families.aliases.update","product_families.aliases.delete","products.customer_part_numbers.create","products.customer_part_numbers.update","products.customer_part_numbers.delete","product_sds.update","product_documents.create","customer_documents.create","supplier_documents.create","purchase_order_documents.create","product_families.create","product_families.update","cost_book_entries.create","current_cost_sources.put","customers.archive","customers.unarchive","suppliers.archive","suppliers.unarchive","contacts.archive","contacts.unarchive","customer_addresses.archive","customer_addresses.unarchive","supplier_ship_from_locations.archive","supplier_ship_from_locations.unarchive","representatives.create","representatives.update","representatives.archive","representatives.unarchive","payment_terms.create","payment_terms.update","ledger_accounts.create","ledger_accounts.update"]},"status":{"type":"string","enum":["ready","blocked"]},"wouldWrite":{"type":"boolean","enum":[false]},"submit":{"type":"object","properties":{"method":{"type":"string","enum":["POST","PATCH","PUT","DELETE"]},"path":{"type":"string"},"query":{"type":"object","properties":{},"additionalProperties":false}},"required":["method","path","query"],"additionalProperties":false},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false},"checks":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["not_direct_ship","address_role_required","address_role_valid","already_assigned","already_exists","active_duplicate","ambiguous_external_id","ambiguous_natural_key","api_created","archived_target","archived_record","archive_blocked","account_type_locked","duplicate_candidate_found","duplicate_candidate_overflow","duplicate_check_clear","duplicate_check_not_needed","duplicate_contact","duplicate_customer","duplicate_customer_address","duplicate_customer_location","duplicate_note","duplicate_resolution_applied","duplicate_supplier","duplicate_supplier_ship_from_location","document_url_org_scoped","document_url_valid","upload_verified","sds_converged","idempotency_available","idempotency_key_required","idempotency_key_reused","idempotency_replay","idempotency_target_missing","income_statement_type_invalid","hard_identity_clear","nested_external_id_clear","commercial_references_valid","credit_denomination_mismatch","customer_service_representative_reference_active","ledger_account_reference_valid","payment_terms_reference_exists","sales_person_reference_active","supplier_representative_reference_active","duplicate_reference_identity","external_id_conflict","if_match_current","base_uom_transition_allowed","base_uom_transition_blocked","attribute_assignments_valid","attribute_assignments_invalid","selected_supplier_link","linked_records_available","natural_key_conflict","not_api_created","no_downstream_mutation","order_sensitive_update_allowed","order_sensitive_update_blocked","parent_available","cost_book_entry_blocked","cost_book_entry_valid","cost_book_reference_not_visible","unsupported_cost_book_uom","cost_uom_conversion_unavailable","cost_book_base_unavailable","cost_book_base_ambiguous","cost_ship_from_location_not_visible","cost_package_quantity_invalid","cost_component_invalid","cost_date_window_invalid","cost_date_overlap","cost_amount_overflow","cost_book_conflict","product_family_reference_active","product_packaging_reference_active","primary_child_available","primary_change_unsupported","reference_visibility_blocked","scope_authorized","stale_record","stale_cost_book_entry","supplier_reference_active","tag_applicable","tag_available","tag_exists","tag_found","tag_not_applicable","tag_not_found","type_immutable","type_known","type_required","target_active","target_available","target_not_found_or_not_visible","targets_visible","unsupported_linked_record","unsupported_profile_shape","variable_qty_valid","validation_failed","value_nonempty"]},"status":{"type":"string","enum":["passed","blocked"]},"message":{"type":"string"},"param":{"type":"string"}},"required":["code","status","message"],"additionalProperties":false}},"duplicateCandidates":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact","customer","supplier","customer_location","customer_address","supplier_ship_from_location","product","product_family","document"]},"readable":{"type":"boolean"},"version":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","product","purchase_order"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"matchReasons":{"type":"array","items":{"type":"string","enum":["name","email","externalId","address","code","product","url"]}},"readbackPath":{"type":"string"}},"required":["type","readable","matchReasons"],"additionalProperties":false}},"idempotency":{"type":"object","properties":{"required":{"type":"boolean"},"keyProvided":{"type":"boolean"},"wouldReplay":{"type":"boolean"}},"required":["required","keyProvided","wouldReplay"],"additionalProperties":false},"wouldChange":{"type":"object","properties":{"fieldNames":{"type":"array","items":{"type":"string"}},"values":{"type":"object","additionalProperties":{}}},"required":["fieldNames","values"],"additionalProperties":false},"impactAnalysis":{"type":"object","additionalProperties":{}},"requestId":{"type":"string"}},"required":["type","operation","status","wouldWrite","submit","verification","checks","duplicateCandidates","requestId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}]}}}},"201":{"description":"Product created.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["product"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"url":{"type":"string"},"archived":{"type":"boolean"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"code":{"type":"string"},"externalId":{"type":["string","null"]},"casNumber":{"type":["string","null"]},"ghsSignalWord":{"type":["string","null"]},"qty":{"type":["string","null"]},"packagingType":{"type":["string","null"],"enum":["FIXED","VARIABLE"]},"supplierType":{"type":["string","null"],"enum":["FIXED","VARIABLE"]},"freightClass":{"type":["string","null"]},"nmfcCode":{"type":["string","null"]},"netUnitWeightLbs":{"type":["string","null"]},"packagesPerPallet":{"type":["integer","null"]},"productFamily":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"casNumber":{"type":["string","null"]},"molecularFormula":{"type":["string","null"]},"unNumbers":{"type":"array","items":{"type":"string"}},"ghsSignalWord":{"type":["string","null"]},"hazardSymbols":{"type":"array","items":{"type":"string"}}},"required":["id","name","casNumber","molecularFormula","unNumbers","ghsSignalWord","hazardSymbols"],"additionalProperties":false},"supplier":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"archived":{"type":"boolean"}},"required":["id","displayName","archived"],"additionalProperties":false},"packaging":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"unitOfMeasure":{"type":"string"},"isBulk":{"type":"boolean"},"tareWeightLbs":{"type":["string","null"]},"capacity":{"type":["string","null"]},"material":{"type":["string","null"]},"unSpecCode":{"type":["string","null"]},"maxGrossWeightLbs":{"type":["string","null"]}},"required":["id","name","unitOfMeasure","isBulk","tareWeightLbs","capacity","material","unSpecCode","maxGrossWeightLbs"],"additionalProperties":false},"hazmat":{"type":"object","properties":{"unNumber":{"type":["string","null"]},"properShippingName":{"type":["string","null"]},"hazardClass":{"type":"array","items":{"type":"string"}},"packingGroup":{"type":["string","null"]},"specialDesignation":{"type":["string","null"]},"hazardSymbols":{"type":"array","items":{"type":"string"}}},"required":["unNumber","properShippingName","hazardClass","packingGroup","specialDesignation","hazardSymbols"],"additionalProperties":false},"catalog":{"type":"object","properties":{"family":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"externalId":{"type":["string","null"]}},"required":["id","externalId"],"additionalProperties":false},"packaging":{"type":"object","properties":{"id":{"type":"string","format":"uuid"}},"required":["id"],"additionalProperties":false},"archived":{"type":"boolean"},"links":{"type":"object","properties":{"attributeAssignments":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":"string"}},"required":["available","method","path"],"additionalProperties":false},"suppliers":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":"string"}},"required":["available","method","path"],"additionalProperties":false},"aliases":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":"string"}},"required":["available","method","path"],"additionalProperties":false},"customerPartNumbers":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":"string"}},"required":["available","method","path"],"additionalProperties":false}},"required":["attributeAssignments","suppliers","aliases","customerPartNumbers"],"additionalProperties":false}},"required":["family","packaging","archived","links"],"additionalProperties":false},"idempotencyStatus":{"type":"string","enum":["created","replayed"]},"attributeAssignments":{"type":"array","items":{"type":"object","properties":{"attributeId":{"type":"string","format":"uuid"},"optionIds":{"type":"array","items":{"type":"string","format":"uuid"}},"textValue":{"type":["string","null"],"maxLength":500},"booleanValue":{"type":["boolean","null"]}},"required":["attributeId"],"additionalProperties":false},"description":"The normalized assignment set accepted by this create or explicit PATCH replacement. Omitted when PATCH did not submit assignments; replay repeats the accepted request set, not a read of current stored assignments."}},"required":["type","id","displayName","url","archived","createdAt","updatedAt","code","externalId","casNumber","ghsSignalWord","qty","packagingType","supplierType","freightClass","nmfcCode","netUnitWeightLbs","packagesPerPallet","productFamily","supplier","packaging","hazmat","catalog"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested parent or record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"409":{"description":"The write conflicted with an existing record, idempotency payload, or stale If-Match value.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/products/{id}":{"get":{"operationId":"getPublicAPIProduct","summary":"Get a product","description":"The product id is supplied in the path. This operation accepts no query filters and no request body. Returns a safe read-only product detail DTO visible to the acting user.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":["products:read","search:read"],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Product detail.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["product"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"url":{"type":"string"},"archived":{"type":"boolean"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"code":{"type":"string"},"externalId":{"type":["string","null"]},"casNumber":{"type":["string","null"]},"ghsSignalWord":{"type":["string","null"]},"qty":{"type":["string","null"]},"packagingType":{"type":["string","null"],"enum":["FIXED","VARIABLE"]},"supplierType":{"type":["string","null"],"enum":["FIXED","VARIABLE"]},"freightClass":{"type":["string","null"]},"nmfcCode":{"type":["string","null"]},"netUnitWeightLbs":{"type":["string","null"]},"packagesPerPallet":{"type":["integer","null"]},"productFamily":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"casNumber":{"type":["string","null"]},"molecularFormula":{"type":["string","null"]},"unNumbers":{"type":"array","items":{"type":"string"}},"ghsSignalWord":{"type":["string","null"]},"hazardSymbols":{"type":"array","items":{"type":"string"}}},"required":["id","name","casNumber","molecularFormula","unNumbers","ghsSignalWord","hazardSymbols"],"additionalProperties":false},"supplier":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"archived":{"type":"boolean"}},"required":["id","displayName","archived"],"additionalProperties":false},"packaging":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"unitOfMeasure":{"type":"string"},"isBulk":{"type":"boolean"},"tareWeightLbs":{"type":["string","null"]},"capacity":{"type":["string","null"]},"material":{"type":["string","null"]},"unSpecCode":{"type":["string","null"]},"maxGrossWeightLbs":{"type":["string","null"]}},"required":["id","name","unitOfMeasure","isBulk","tareWeightLbs","capacity","material","unSpecCode","maxGrossWeightLbs"],"additionalProperties":false},"hazmat":{"type":"object","properties":{"unNumber":{"type":["string","null"]},"properShippingName":{"type":["string","null"]},"hazardClass":{"type":"array","items":{"type":"string"}},"packingGroup":{"type":["string","null"]},"specialDesignation":{"type":["string","null"]},"hazardSymbols":{"type":"array","items":{"type":"string"}}},"required":["unNumber","properShippingName","hazardClass","packingGroup","specialDesignation","hazardSymbols"],"additionalProperties":false},"catalog":{"type":"object","properties":{"family":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"externalId":{"type":["string","null"]}},"required":["id","externalId"],"additionalProperties":false},"packaging":{"type":"object","properties":{"id":{"type":"string","format":"uuid"}},"required":["id"],"additionalProperties":false},"archived":{"type":"boolean"},"links":{"type":"object","properties":{"attributeAssignments":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":"string"}},"required":["available","method","path"],"additionalProperties":false},"suppliers":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":"string"}},"required":["available","method","path"],"additionalProperties":false},"aliases":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":"string"}},"required":["available","method","path"],"additionalProperties":false},"customerPartNumbers":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":"string"}},"required":["available","method","path"],"additionalProperties":false}},"required":["attributeAssignments","suppliers","aliases","customerPartNumbers"],"additionalProperties":false}},"required":["family","packaging","archived","links"],"additionalProperties":false},"idempotencyStatus":{"type":"string","enum":["created","replayed"]}},"required":["type","id","displayName","url","archived","createdAt","updatedAt","code","externalId","casNumber","ghsSignalWord","qty","packagingType","supplierType","freightClass","nmfcCode","netUnitWeightLbs","packagesPerPallet","productFamily","supplier","packaging","hazmat","catalog"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updatePublicAPIProduct","summary":"Update a product","description":"Updates product identity, packaging, supplier details, metadata, and hazmat fields. A unique product code can be renamed while connected sales, purchasing, inventory, pricing, cost, and accounting history remains attached to the same product. Send the latest updatedAt value in If-Match, or use dryRun=true to preview readiness. Other structural product changes continue to follow their existing readiness checks.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"products:write","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","enum":["true"]},"required":false,"name":"dryRun","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check."},"required":false,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check.","name":"If-Match","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","minLength":1,"maxLength":120},"externalId":{"type":["string","null"],"maxLength":120},"productFamilyId":{"type":"string","format":"uuid"},"packagingId":{"type":"string","format":"uuid"},"supplierId":{"type":["string","null"],"format":"uuid"},"packagingType":{"type":"string","enum":["FIXED","VARIABLE"]},"supplierType":{"type":"string","enum":["FIXED","VARIABLE"]},"qty":{"anyOf":[{"type":"string"},{"type":"number"}]},"casNumber":{"type":["string","null"],"maxLength":80},"ghsSignalWord":{"type":["string","null"],"enum":["DANGER","WARNING"]},"freightClass":{"type":["string","null"],"maxLength":40},"nmfcCode":{"type":["string","null"],"maxLength":20},"netUnitWeightLbs":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"null"}]},"unNumber":{"type":["string","null"],"maxLength":20},"properShippingName":{"type":["string","null"],"maxLength":240},"hazardClass":{"type":"array","items":{"type":"string","minLength":1,"maxLength":40}},"packingGroup":{"type":["string","null"],"maxLength":20},"specialDesignation":{"type":["string","null"],"maxLength":120},"packagesPerPallet":{"type":["integer","null"],"minimum":0},"hazardSymbols":{"type":"array","items":{"type":"string","minLength":1,"maxLength":80}},"attributeAssignments":{"type":"array","items":{"type":"object","properties":{"attributeId":{"type":"string","format":"uuid"},"optionIds":{"type":"array","items":{"type":"string","format":"uuid"}},"textValue":{"type":["string","null"],"maxLength":500},"booleanValue":{"type":["boolean","null"]}},"required":["attributeId"],"additionalProperties":false}}},"additionalProperties":false}}}},"responses":{"200":{"description":"Updated product, or dryRun returned write readiness.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["product"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"url":{"type":"string"},"archived":{"type":"boolean"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"code":{"type":"string"},"externalId":{"type":["string","null"]},"casNumber":{"type":["string","null"]},"ghsSignalWord":{"type":["string","null"]},"qty":{"type":["string","null"]},"packagingType":{"type":["string","null"],"enum":["FIXED","VARIABLE"]},"supplierType":{"type":["string","null"],"enum":["FIXED","VARIABLE"]},"freightClass":{"type":["string","null"]},"nmfcCode":{"type":["string","null"]},"netUnitWeightLbs":{"type":["string","null"]},"packagesPerPallet":{"type":["integer","null"]},"productFamily":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"casNumber":{"type":["string","null"]},"molecularFormula":{"type":["string","null"]},"unNumbers":{"type":"array","items":{"type":"string"}},"ghsSignalWord":{"type":["string","null"]},"hazardSymbols":{"type":"array","items":{"type":"string"}}},"required":["id","name","casNumber","molecularFormula","unNumbers","ghsSignalWord","hazardSymbols"],"additionalProperties":false},"supplier":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"archived":{"type":"boolean"}},"required":["id","displayName","archived"],"additionalProperties":false},"packaging":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"unitOfMeasure":{"type":"string"},"isBulk":{"type":"boolean"},"tareWeightLbs":{"type":["string","null"]},"capacity":{"type":["string","null"]},"material":{"type":["string","null"]},"unSpecCode":{"type":["string","null"]},"maxGrossWeightLbs":{"type":["string","null"]}},"required":["id","name","unitOfMeasure","isBulk","tareWeightLbs","capacity","material","unSpecCode","maxGrossWeightLbs"],"additionalProperties":false},"hazmat":{"type":"object","properties":{"unNumber":{"type":["string","null"]},"properShippingName":{"type":["string","null"]},"hazardClass":{"type":"array","items":{"type":"string"}},"packingGroup":{"type":["string","null"]},"specialDesignation":{"type":["string","null"]},"hazardSymbols":{"type":"array","items":{"type":"string"}}},"required":["unNumber","properShippingName","hazardClass","packingGroup","specialDesignation","hazardSymbols"],"additionalProperties":false},"catalog":{"type":"object","properties":{"family":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"externalId":{"type":["string","null"]}},"required":["id","externalId"],"additionalProperties":false},"packaging":{"type":"object","properties":{"id":{"type":"string","format":"uuid"}},"required":["id"],"additionalProperties":false},"archived":{"type":"boolean"},"links":{"type":"object","properties":{"attributeAssignments":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":"string"}},"required":["available","method","path"],"additionalProperties":false},"suppliers":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":"string"}},"required":["available","method","path"],"additionalProperties":false},"aliases":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":"string"}},"required":["available","method","path"],"additionalProperties":false},"customerPartNumbers":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":"string"}},"required":["available","method","path"],"additionalProperties":false}},"required":["attributeAssignments","suppliers","aliases","customerPartNumbers"],"additionalProperties":false}},"required":["family","packaging","archived","links"],"additionalProperties":false},"idempotencyStatus":{"type":"string","enum":["created","replayed"]},"attributeAssignments":{"type":"array","items":{"type":"object","properties":{"attributeId":{"type":"string","format":"uuid"},"optionIds":{"type":"array","items":{"type":"string","format":"uuid"}},"textValue":{"type":["string","null"],"maxLength":500},"booleanValue":{"type":["boolean","null"]}},"required":["attributeId"],"additionalProperties":false},"description":"The normalized assignment set accepted by this create or explicit PATCH replacement. Omitted when PATCH did not submit assignments; replay repeats the accepted request set, not a read of current stored assignments."}},"required":["type","id","displayName","url","archived","createdAt","updatedAt","code","externalId","casNumber","ghsSignalWord","qty","packagingType","supplierType","freightClass","nmfcCode","netUnitWeightLbs","packagesPerPallet","productFamily","supplier","packaging","hazmat","catalog"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["write_readiness"]},"operation":{"type":"string","enum":["warehouses.create","warehouses.update","warehouses.archive","warehouses.unarchive","shipping_options.create","shipping_options.update","shipping_options.archive","shipping_options.unarchive","reorder_points.create","tags.create","tags.update","tag_assignments.create","tag_assignments.delete","notes.create","notes.update","opportunities.create","opportunities.update","opportunities.close","opportunities.meta-upsert","contacts.create","contacts.update","customers.create","customers.update","customer_locations.create","customer_locations.update","customer_addresses.create","customer_addresses.update","suppliers.create","suppliers.update","supplier_ship_from_locations.create","supplier_ship_from_locations.update","products.create","products.update","products.archive","products.unarchive","product_packaging.create","products.suppliers.create","products.suppliers.delete","products.aliases.create","products.aliases.update","products.aliases.delete","product_families.aliases.create","product_families.aliases.update","product_families.aliases.delete","products.customer_part_numbers.create","products.customer_part_numbers.update","products.customer_part_numbers.delete","product_sds.update","product_documents.create","customer_documents.create","supplier_documents.create","purchase_order_documents.create","product_families.create","product_families.update","cost_book_entries.create","current_cost_sources.put","customers.archive","customers.unarchive","suppliers.archive","suppliers.unarchive","contacts.archive","contacts.unarchive","customer_addresses.archive","customer_addresses.unarchive","supplier_ship_from_locations.archive","supplier_ship_from_locations.unarchive","representatives.create","representatives.update","representatives.archive","representatives.unarchive","payment_terms.create","payment_terms.update","ledger_accounts.create","ledger_accounts.update"]},"status":{"type":"string","enum":["ready","blocked"]},"wouldWrite":{"type":"boolean","enum":[false]},"submit":{"type":"object","properties":{"method":{"type":"string","enum":["POST","PATCH","PUT","DELETE"]},"path":{"type":"string"},"query":{"type":"object","properties":{},"additionalProperties":false}},"required":["method","path","query"],"additionalProperties":false},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false},"checks":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["not_direct_ship","address_role_required","address_role_valid","already_assigned","already_exists","active_duplicate","ambiguous_external_id","ambiguous_natural_key","api_created","archived_target","archived_record","archive_blocked","account_type_locked","duplicate_candidate_found","duplicate_candidate_overflow","duplicate_check_clear","duplicate_check_not_needed","duplicate_contact","duplicate_customer","duplicate_customer_address","duplicate_customer_location","duplicate_note","duplicate_resolution_applied","duplicate_supplier","duplicate_supplier_ship_from_location","document_url_org_scoped","document_url_valid","upload_verified","sds_converged","idempotency_available","idempotency_key_required","idempotency_key_reused","idempotency_replay","idempotency_target_missing","income_statement_type_invalid","hard_identity_clear","nested_external_id_clear","commercial_references_valid","credit_denomination_mismatch","customer_service_representative_reference_active","ledger_account_reference_valid","payment_terms_reference_exists","sales_person_reference_active","supplier_representative_reference_active","duplicate_reference_identity","external_id_conflict","if_match_current","base_uom_transition_allowed","base_uom_transition_blocked","attribute_assignments_valid","attribute_assignments_invalid","selected_supplier_link","linked_records_available","natural_key_conflict","not_api_created","no_downstream_mutation","order_sensitive_update_allowed","order_sensitive_update_blocked","parent_available","cost_book_entry_blocked","cost_book_entry_valid","cost_book_reference_not_visible","unsupported_cost_book_uom","cost_uom_conversion_unavailable","cost_book_base_unavailable","cost_book_base_ambiguous","cost_ship_from_location_not_visible","cost_package_quantity_invalid","cost_component_invalid","cost_date_window_invalid","cost_date_overlap","cost_amount_overflow","cost_book_conflict","product_family_reference_active","product_packaging_reference_active","primary_child_available","primary_change_unsupported","reference_visibility_blocked","scope_authorized","stale_record","stale_cost_book_entry","supplier_reference_active","tag_applicable","tag_available","tag_exists","tag_found","tag_not_applicable","tag_not_found","type_immutable","type_known","type_required","target_active","target_available","target_not_found_or_not_visible","targets_visible","unsupported_linked_record","unsupported_profile_shape","variable_qty_valid","validation_failed","value_nonempty"]},"status":{"type":"string","enum":["passed","blocked"]},"message":{"type":"string"},"param":{"type":"string"}},"required":["code","status","message"],"additionalProperties":false}},"duplicateCandidates":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact","customer","supplier","customer_location","customer_address","supplier_ship_from_location","product","product_family","document"]},"readable":{"type":"boolean"},"version":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","product","purchase_order"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"matchReasons":{"type":"array","items":{"type":"string","enum":["name","email","externalId","address","code","product","url"]}},"readbackPath":{"type":"string"}},"required":["type","readable","matchReasons"],"additionalProperties":false}},"idempotency":{"type":"object","properties":{"required":{"type":"boolean"},"keyProvided":{"type":"boolean"},"wouldReplay":{"type":"boolean"}},"required":["required","keyProvided","wouldReplay"],"additionalProperties":false},"wouldChange":{"type":"object","properties":{"fieldNames":{"type":"array","items":{"type":"string"}},"values":{"type":"object","additionalProperties":{}}},"required":["fieldNames","values"],"additionalProperties":false},"impactAnalysis":{"type":"object","additionalProperties":{}},"requestId":{"type":"string"}},"required":["type","operation","status","wouldWrite","submit","verification","checks","duplicateCandidates","requestId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}]}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested parent or record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"409":{"description":"The write conflicted with an existing record, idempotency payload, or stale If-Match value.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/products/{id}/documents":{"get":{"operationId":"listPublicAPIProductDocuments","summary":"List product documents","description":"Returns attached documents on one visible product, omitting dismissed rows, plus the product SDS file when present. The SDS entry may point at the same URL as a document row; it answers the product SDS question while documents are the audit trail. ShelfCycle bucket files are returned as 15-minute signed read URLs.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":["products:read","search:read"],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Product attached documents and optional SDS entry.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"documents":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["document"]},"id":{"type":"string","format":"uuid"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"urlClass":{"type":"string","enum":["shelfcycle","external"]},"access":{"type":"object","properties":{"mode":{"type":"string","enum":["signed","raw","unavailable"]},"url":{"type":"string"},"expiresAt":{"type":"string","format":"date-time"}},"required":["mode"],"additionalProperties":false}},"required":["type","id","fileName","createdAt","urlClass","access"],"additionalProperties":false}},"truncated":{"type":"boolean"},"sds":{"type":["object","null"],"properties":{"fileName":{"type":"string"},"access":{"type":"object","properties":{"mode":{"type":"string","enum":["signed","raw","unavailable"]},"url":{"type":"string"},"expiresAt":{"type":"string","format":"date-time"}},"required":["mode"],"additionalProperties":false}},"required":["fileName","access"],"additionalProperties":false}},"required":["documents","truncated","sds"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}},"post":{"operationId":"createPublicAPIProductDocument","summary":"Attach a product document","description":"Creates an attached document on a visible active product. Execute requests require Idempotency-Key. dryRun=true may omit Idempotency-Key and returns a blocked readiness check instead of writing. The body may be an existing external/legacy link or data.document from the upload-grant route. New API-upload descriptors are HEAD-verified only after replay and duplicate checks. This creates one Document row and one idempotency identity only. It does not transport binary files through the application, mutate Product.sdsFile, change hazmat fields, delete documents, or touch inventory, lots, pricing, costs, orders, or accounting records. A valid API-upload descriptor may be passed between keys in the same organization. documents:upload is required only to mint the grant; association and SDS routes require their documented target write scope and current ShelfCycle access. Descriptor possession grants no read access. API-upload association create and replay responses omit signed access unless the calling key also has the target read scope and live view permission.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"products:write","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","enum":["true"]},"required":false,"name":"dryRun","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Required for execute requests. dryRun=true may omit this header and receive an idempotency_key_required check."},"required":false,"description":"Required for execute requests. dryRun=true may omit this header and receive an idempotency_key_required check.","name":"Idempotency-Key","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"fileName":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[^\\u0000-\\u001F\\u007F]*$"},"url":{"type":"string","minLength":1,"maxLength":2048}},"required":["fileName","url"],"additionalProperties":false}}}},"responses":{"200":{"description":"Idempotent replay returned the existing product document, or dryRun returned write readiness.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["document"]},"id":{"type":"string","format":"uuid"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"urlClass":{"type":"string","enum":["shelfcycle","external"]},"access":{"type":"object","properties":{"mode":{"type":"string","enum":["signed","raw","unavailable"]},"url":{"type":"string"},"expiresAt":{"type":"string","format":"date-time"}},"required":["mode"],"additionalProperties":false},"idempotencyStatus":{"type":"string","enum":["created","replayed"]},"integrity":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","enum":["verified"]},"checksumSha256":{"type":"string","pattern":"^[a-f0-9]{64}$","description":"Lowercase SHA-256 matched by the association-time storage HEAD check."},"sizeBytes":{"type":"integer","exclusiveMinimum":0,"description":"Storage-reported object size verified at association time."},"contentType":{"type":"string","minLength":1,"description":"Storage-reported canonical content type verified at association time."},"verifiedAt":{"type":"string","format":"date-time","description":"Time ShelfCycle completed the association verification."}},"required":["status","checksumSha256","sizeBytes","contentType","verifiedAt"],"additionalProperties":false,"description":"Durable association receipt; it is not malware scanning, content interpretation, or perpetual-retention proof."},{"type":"object","properties":{"status":{"type":"string","enum":["not_verified"]},"reason":{"type":"string","enum":["external_or_legacy_link"]}},"required":["status","reason"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","enum":["unavailable"]},"reason":{"type":"string","enum":["legacy_receipt_not_recorded"]}},"required":["status","reason"],"additionalProperties":false}]}},"required":["type","id","fileName","createdAt","urlClass","access","idempotencyStatus","integrity"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["write_readiness"]},"operation":{"type":"string","enum":["warehouses.create","warehouses.update","warehouses.archive","warehouses.unarchive","shipping_options.create","shipping_options.update","shipping_options.archive","shipping_options.unarchive","reorder_points.create","tags.create","tags.update","tag_assignments.create","tag_assignments.delete","notes.create","notes.update","opportunities.create","opportunities.update","opportunities.close","opportunities.meta-upsert","contacts.create","contacts.update","customers.create","customers.update","customer_locations.create","customer_locations.update","customer_addresses.create","customer_addresses.update","suppliers.create","suppliers.update","supplier_ship_from_locations.create","supplier_ship_from_locations.update","products.create","products.update","products.archive","products.unarchive","product_packaging.create","products.suppliers.create","products.suppliers.delete","products.aliases.create","products.aliases.update","products.aliases.delete","product_families.aliases.create","product_families.aliases.update","product_families.aliases.delete","products.customer_part_numbers.create","products.customer_part_numbers.update","products.customer_part_numbers.delete","product_sds.update","product_documents.create","customer_documents.create","supplier_documents.create","purchase_order_documents.create","product_families.create","product_families.update","cost_book_entries.create","current_cost_sources.put","customers.archive","customers.unarchive","suppliers.archive","suppliers.unarchive","contacts.archive","contacts.unarchive","customer_addresses.archive","customer_addresses.unarchive","supplier_ship_from_locations.archive","supplier_ship_from_locations.unarchive","representatives.create","representatives.update","representatives.archive","representatives.unarchive","payment_terms.create","payment_terms.update","ledger_accounts.create","ledger_accounts.update"]},"status":{"type":"string","enum":["ready","blocked"]},"wouldWrite":{"type":"boolean","enum":[false]},"submit":{"type":"object","properties":{"method":{"type":"string","enum":["POST","PATCH","PUT","DELETE"]},"path":{"type":"string"},"query":{"type":"object","properties":{},"additionalProperties":false}},"required":["method","path","query"],"additionalProperties":false},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false},"checks":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["not_direct_ship","address_role_required","address_role_valid","already_assigned","already_exists","active_duplicate","ambiguous_external_id","ambiguous_natural_key","api_created","archived_target","archived_record","archive_blocked","account_type_locked","duplicate_candidate_found","duplicate_candidate_overflow","duplicate_check_clear","duplicate_check_not_needed","duplicate_contact","duplicate_customer","duplicate_customer_address","duplicate_customer_location","duplicate_note","duplicate_resolution_applied","duplicate_supplier","duplicate_supplier_ship_from_location","document_url_org_scoped","document_url_valid","upload_verified","sds_converged","idempotency_available","idempotency_key_required","idempotency_key_reused","idempotency_replay","idempotency_target_missing","income_statement_type_invalid","hard_identity_clear","nested_external_id_clear","commercial_references_valid","credit_denomination_mismatch","customer_service_representative_reference_active","ledger_account_reference_valid","payment_terms_reference_exists","sales_person_reference_active","supplier_representative_reference_active","duplicate_reference_identity","external_id_conflict","if_match_current","base_uom_transition_allowed","base_uom_transition_blocked","attribute_assignments_valid","attribute_assignments_invalid","selected_supplier_link","linked_records_available","natural_key_conflict","not_api_created","no_downstream_mutation","order_sensitive_update_allowed","order_sensitive_update_blocked","parent_available","cost_book_entry_blocked","cost_book_entry_valid","cost_book_reference_not_visible","unsupported_cost_book_uom","cost_uom_conversion_unavailable","cost_book_base_unavailable","cost_book_base_ambiguous","cost_ship_from_location_not_visible","cost_package_quantity_invalid","cost_component_invalid","cost_date_window_invalid","cost_date_overlap","cost_amount_overflow","cost_book_conflict","product_family_reference_active","product_packaging_reference_active","primary_child_available","primary_change_unsupported","reference_visibility_blocked","scope_authorized","stale_record","stale_cost_book_entry","supplier_reference_active","tag_applicable","tag_available","tag_exists","tag_found","tag_not_applicable","tag_not_found","type_immutable","type_known","type_required","target_active","target_available","target_not_found_or_not_visible","targets_visible","unsupported_linked_record","unsupported_profile_shape","variable_qty_valid","validation_failed","value_nonempty"]},"status":{"type":"string","enum":["passed","blocked"]},"message":{"type":"string"},"param":{"type":"string"}},"required":["code","status","message"],"additionalProperties":false}},"duplicateCandidates":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact","customer","supplier","customer_location","customer_address","supplier_ship_from_location","product","product_family","document"]},"readable":{"type":"boolean"},"version":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","product","purchase_order"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"matchReasons":{"type":"array","items":{"type":"string","enum":["name","email","externalId","address","code","product","url"]}},"readbackPath":{"type":"string"}},"required":["type","readable","matchReasons"],"additionalProperties":false}},"idempotency":{"type":"object","properties":{"required":{"type":"boolean"},"keyProvided":{"type":"boolean"},"wouldReplay":{"type":"boolean"}},"required":["required","keyProvided","wouldReplay"],"additionalProperties":false},"wouldChange":{"type":"object","properties":{"fieldNames":{"type":"array","items":{"type":"string"}},"values":{"type":"object","additionalProperties":{}}},"required":["fieldNames","values"],"additionalProperties":false},"impactAnalysis":{"type":"object","additionalProperties":{}},"requestId":{"type":"string"}},"required":["type","operation","status","wouldWrite","submit","verification","checks","duplicateCandidates","requestId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}]},"examples":{"verified-api-upload-replay":{"summary":"Exact replay returns the stored association receipt without another storage check","value":{"data":{"type":"document","id":"11111111-1111-4111-8111-111111111111","fileName":"Supplier Confirmation.pdf","createdAt":"2026-08-11T12:00:00.000Z","urlClass":"shelfcycle","access":{"mode":"unavailable"},"idempotencyStatus":"replayed","integrity":{"status":"verified","checksumSha256":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","sizeBytes":4096,"contentType":"application/pdf","verifiedAt":"2026-08-11T12:00:00.000Z"}}}}}}}},"201":{"description":"Product document created.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["document"]},"id":{"type":"string","format":"uuid"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"urlClass":{"type":"string","enum":["shelfcycle","external"]},"access":{"type":"object","properties":{"mode":{"type":"string","enum":["signed","raw","unavailable"]},"url":{"type":"string"},"expiresAt":{"type":"string","format":"date-time"}},"required":["mode"],"additionalProperties":false},"idempotencyStatus":{"type":"string","enum":["created","replayed"]},"integrity":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","enum":["verified"]},"checksumSha256":{"type":"string","pattern":"^[a-f0-9]{64}$","description":"Lowercase SHA-256 matched by the association-time storage HEAD check."},"sizeBytes":{"type":"integer","exclusiveMinimum":0,"description":"Storage-reported object size verified at association time."},"contentType":{"type":"string","minLength":1,"description":"Storage-reported canonical content type verified at association time."},"verifiedAt":{"type":"string","format":"date-time","description":"Time ShelfCycle completed the association verification."}},"required":["status","checksumSha256","sizeBytes","contentType","verifiedAt"],"additionalProperties":false,"description":"Durable association receipt; it is not malware scanning, content interpretation, or perpetual-retention proof."},{"type":"object","properties":{"status":{"type":"string","enum":["not_verified"]},"reason":{"type":"string","enum":["external_or_legacy_link"]}},"required":["status","reason"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","enum":["unavailable"]},"reason":{"type":"string","enum":["legacy_receipt_not_recorded"]}},"required":["status","reason"],"additionalProperties":false}]}},"required":["type","id","fileName","createdAt","urlClass","access","idempotencyStatus","integrity"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},"examples":{"verified-api-upload":{"summary":"API-upload association with a durable integrity receipt","value":{"data":{"type":"document","id":"11111111-1111-4111-8111-111111111111","fileName":"Supplier Confirmation.pdf","createdAt":"2026-08-11T12:00:00.000Z","urlClass":"shelfcycle","access":{"mode":"unavailable"},"idempotencyStatus":"created","integrity":{"status":"verified","checksumSha256":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","sizeBytes":4096,"contentType":"application/pdf","verifiedAt":"2026-08-11T12:00:00.000Z"}}}}}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested parent or record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"409":{"description":"The write conflicted with an existing record, idempotency payload, or stale If-Match value.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/products/{id}/sds":{"put":{"operationId":"updatePublicAPIProductSDS","summary":"Assign a current Product SDS","description":"Updates one uploaded PDF or raster image as the Product's current SDS. Execute requests require If-Match. dryRun=true may omit If-Match and returns a blocked readiness check instead of writing. The body must be the document descriptor from POST /api/v1/document-uploads. Exact converged retries return 200 without depending on S3 availability. A prospective assign, repair, rename, or replacement requires current If-Match and verifies the private object's size, declared type, and grant-bound checksum before opening the database transaction. The transaction updates only Product.sdsFile and ensures one Product Document row; prior documents remain evidence history and hazmat fields are unchanged. GET /api/v1/products/{id}/documents verifies both data.sds and sidebar documents. A valid API-upload descriptor may be passed between keys in the same organization. documents:upload is required only to mint the grant; association and SDS routes require their documented target write scope and current ShelfCycle access. Descriptor possession grants no read access. API-upload association create and replay responses omit signed access unless the calling key also has the target read scope and live view permission.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"products:write","x-required-scopes-all":["products:write"],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","enum":["true"]},"required":false,"name":"dryRun","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check."},"required":false,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check.","name":"If-Match","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"fileName":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[^\\u0000-\\u001F\\u007F]*$"},"url":{"type":"string","minLength":1,"maxLength":2048}},"required":["fileName","url"],"additionalProperties":false}}}},"responses":{"200":{"description":"Product SDS updated, repaired, replayed, or dryRun returned write readiness.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["product_sds"]},"productId":{"type":"string","format":"uuid"},"fileName":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"},"idempotencyStatus":{"type":"string","enum":["updated","replayed","repaired"]}},"required":["type","productId","fileName","updatedAt","idempotencyStatus"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["write_readiness"]},"operation":{"type":"string","enum":["warehouses.create","warehouses.update","warehouses.archive","warehouses.unarchive","shipping_options.create","shipping_options.update","shipping_options.archive","shipping_options.unarchive","reorder_points.create","tags.create","tags.update","tag_assignments.create","tag_assignments.delete","notes.create","notes.update","opportunities.create","opportunities.update","opportunities.close","opportunities.meta-upsert","contacts.create","contacts.update","customers.create","customers.update","customer_locations.create","customer_locations.update","customer_addresses.create","customer_addresses.update","suppliers.create","suppliers.update","supplier_ship_from_locations.create","supplier_ship_from_locations.update","products.create","products.update","products.archive","products.unarchive","product_packaging.create","products.suppliers.create","products.suppliers.delete","products.aliases.create","products.aliases.update","products.aliases.delete","product_families.aliases.create","product_families.aliases.update","product_families.aliases.delete","products.customer_part_numbers.create","products.customer_part_numbers.update","products.customer_part_numbers.delete","product_sds.update","product_documents.create","customer_documents.create","supplier_documents.create","purchase_order_documents.create","product_families.create","product_families.update","cost_book_entries.create","current_cost_sources.put","customers.archive","customers.unarchive","suppliers.archive","suppliers.unarchive","contacts.archive","contacts.unarchive","customer_addresses.archive","customer_addresses.unarchive","supplier_ship_from_locations.archive","supplier_ship_from_locations.unarchive","representatives.create","representatives.update","representatives.archive","representatives.unarchive","payment_terms.create","payment_terms.update","ledger_accounts.create","ledger_accounts.update"]},"status":{"type":"string","enum":["ready","blocked"]},"wouldWrite":{"type":"boolean","enum":[false]},"submit":{"type":"object","properties":{"method":{"type":"string","enum":["POST","PATCH","PUT","DELETE"]},"path":{"type":"string"},"query":{"type":"object","properties":{},"additionalProperties":false}},"required":["method","path","query"],"additionalProperties":false},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false},"checks":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["not_direct_ship","address_role_required","address_role_valid","already_assigned","already_exists","active_duplicate","ambiguous_external_id","ambiguous_natural_key","api_created","archived_target","archived_record","archive_blocked","account_type_locked","duplicate_candidate_found","duplicate_candidate_overflow","duplicate_check_clear","duplicate_check_not_needed","duplicate_contact","duplicate_customer","duplicate_customer_address","duplicate_customer_location","duplicate_note","duplicate_resolution_applied","duplicate_supplier","duplicate_supplier_ship_from_location","document_url_org_scoped","document_url_valid","upload_verified","sds_converged","idempotency_available","idempotency_key_required","idempotency_key_reused","idempotency_replay","idempotency_target_missing","income_statement_type_invalid","hard_identity_clear","nested_external_id_clear","commercial_references_valid","credit_denomination_mismatch","customer_service_representative_reference_active","ledger_account_reference_valid","payment_terms_reference_exists","sales_person_reference_active","supplier_representative_reference_active","duplicate_reference_identity","external_id_conflict","if_match_current","base_uom_transition_allowed","base_uom_transition_blocked","attribute_assignments_valid","attribute_assignments_invalid","selected_supplier_link","linked_records_available","natural_key_conflict","not_api_created","no_downstream_mutation","order_sensitive_update_allowed","order_sensitive_update_blocked","parent_available","cost_book_entry_blocked","cost_book_entry_valid","cost_book_reference_not_visible","unsupported_cost_book_uom","cost_uom_conversion_unavailable","cost_book_base_unavailable","cost_book_base_ambiguous","cost_ship_from_location_not_visible","cost_package_quantity_invalid","cost_component_invalid","cost_date_window_invalid","cost_date_overlap","cost_amount_overflow","cost_book_conflict","product_family_reference_active","product_packaging_reference_active","primary_child_available","primary_change_unsupported","reference_visibility_blocked","scope_authorized","stale_record","stale_cost_book_entry","supplier_reference_active","tag_applicable","tag_available","tag_exists","tag_found","tag_not_applicable","tag_not_found","type_immutable","type_known","type_required","target_active","target_available","target_not_found_or_not_visible","targets_visible","unsupported_linked_record","unsupported_profile_shape","variable_qty_valid","validation_failed","value_nonempty"]},"status":{"type":"string","enum":["passed","blocked"]},"message":{"type":"string"},"param":{"type":"string"}},"required":["code","status","message"],"additionalProperties":false}},"duplicateCandidates":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact","customer","supplier","customer_location","customer_address","supplier_ship_from_location","product","product_family","document"]},"readable":{"type":"boolean"},"version":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","product","purchase_order"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"matchReasons":{"type":"array","items":{"type":"string","enum":["name","email","externalId","address","code","product","url"]}},"readbackPath":{"type":"string"}},"required":["type","readable","matchReasons"],"additionalProperties":false}},"idempotency":{"type":"object","properties":{"required":{"type":"boolean"},"keyProvided":{"type":"boolean"},"wouldReplay":{"type":"boolean"}},"required":["required","keyProvided","wouldReplay"],"additionalProperties":false},"wouldChange":{"type":"object","properties":{"fieldNames":{"type":"array","items":{"type":"string"}},"values":{"type":"object","additionalProperties":{}}},"required":["fieldNames","values"],"additionalProperties":false},"impactAnalysis":{"type":"object","additionalProperties":{}},"requestId":{"type":"string"}},"required":["type","operation","status","wouldWrite","submit","verification","checks","duplicateCandidates","requestId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}]}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested parent or record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"409":{"description":"The write conflicted with an existing record, idempotency payload, or stale If-Match value.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/suppliers":{"get":{"operationId":"findPublicAPISuppliers","summary":"Find suppliers","description":"Finds suppliers by familiar wording, source identity, creator, or created time. Continue matching pages with the exact returned cursor.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"suppliers:read","parameters":[{"schema":{"type":"string"},"required":false,"name":"q","in":"query"},{"schema":{"type":"string"},"required":false,"name":"externalId","in":"query"},{"schema":{"type":"string"},"required":false,"name":"limit","in":"query"},{"schema":{"type":"string"},"required":false,"name":"includeArchived","in":"query"},{"schema":{"type":"string","format":"uuid"},"required":false,"name":"createdById","in":"query"},{"schema":{"type":"string","format":"date-time"},"required":false,"name":"createdFrom","in":"query"},{"schema":{"type":"string","format":"date-time"},"required":false,"name":"createdTo","in":"query"},{"schema":{"type":"string"},"required":false,"name":"cursor","in":"query"}],"responses":{"200":{"description":"Supplier finder summaries.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["supplier"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"externalId":{"type":["string","null"]},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"website":{"type":["string","null"]},"primaryShipFrom":{"type":["object","null"],"properties":{"id":{"type":["string","null"],"format":"uuid"},"name":{"type":["string","null"]},"street1":{"type":["string","null"]},"street2":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"zip":{"type":["string","null"]},"country":{"type":["string","null"]},"phone":{"type":["string","null"]},"email":{"type":["string","null"]}},"required":["id","name","street1","street2","city","state","zip","country","phone","email"],"additionalProperties":false},"url":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["user"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["system"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string","enum":["System User"]}},"required":["type","id","displayName"],"additionalProperties":false}]},"archived":{"type":"boolean"}},"required":["type","id","displayName","externalId","email","phone","website","primaryShipFrom","url","updatedAt","createdAt","createdBy","archived"],"additionalProperties":false}},"meta":{"type":"object","properties":{"requestId":{"type":"string"},"mode":{"type":"string"},"limit":{"type":"integer"},"hasMore":{"type":"boolean"},"filters":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"changedRecordBasis":{"type":"string","enum":["parent_updated_at"]},"narrowingHints":{"type":"array","items":{"type":"string"}},"nextCursor":{"type":["string","null"]}},"required":["requestId","mode","limit","hasMore","filters","nextCursor"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}},"post":{"operationId":"createPublicAPISupplierProfile","summary":"Create a supplier profile","description":"Creates a bounded supplier profile and optional ship-from address. Execute requests require Idempotency-Key. dryRun=true may omit Idempotency-Key and returns a blocked readiness check instead of writing.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"suppliers:write","parameters":[{"schema":{"type":"string","enum":["true"]},"required":false,"name":"dryRun","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Required for execute requests. dryRun=true may omit this header and receive an idempotency_key_required check."},"required":false,"description":"Required for execute requests. dryRun=true may omit this header and receive an idempotency_key_required check.","name":"Idempotency-Key","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":160},"externalId":{"type":["string","null"],"maxLength":120},"phone":{"type":["string","null"],"maxLength":80},"email":{"type":["string","null"],"maxLength":240},"website":{"type":["string","null"],"maxLength":240},"street1":{"type":["string","null"],"maxLength":240},"street2":{"type":["string","null"],"maxLength":240},"city":{"type":["string","null"],"maxLength":120},"state":{"type":["string","null"],"maxLength":80},"zip":{"type":["string","null"],"maxLength":40},"country":{"type":["string","null"],"maxLength":80},"taxId":{"type":["string","null"],"maxLength":120},"paymentTermsId":{"type":["string","null"],"format":"uuid"},"creditLimit":{"type":["object","null"],"properties":{"amountCents":{"type":["integer","null"],"minimum":0,"maximum":2147483647},"currencyCode":{"type":"string","minLength":3,"maxLength":3}},"required":["amountCents"],"additionalProperties":false},"preferredUnitOfMeasure":{"type":"string","enum":["NoPreference","Metric","Imperial"]},"costLedgerAccountId":{"type":["string","null"],"format":"uuid"},"supplierRepresentativeId":{"type":["string","null"],"format":"uuid"},"primaryShipFromAddress":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":160},"externalId":{"type":["string","null"],"maxLength":120},"street1":{"type":["string","null"],"maxLength":240},"street2":{"type":["string","null"],"maxLength":240},"city":{"type":["string","null"],"maxLength":120},"state":{"type":["string","null"],"maxLength":80},"zip":{"type":["string","null"],"maxLength":40},"country":{"type":["string","null"],"maxLength":80},"email":{"type":["string","null"],"maxLength":240},"phone":{"type":["string","null"],"maxLength":80},"defaultSupplierShippingInstructions":{"type":["string","null"],"maxLength":2000}},"additionalProperties":false},"duplicateResolution":{"type":"string","enum":["create_distinct"]}},"required":["name"],"additionalProperties":false}}}},"responses":{"200":{"description":"Idempotent replay returned the existing supplier profile, or dryRun returned write readiness.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["supplier"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"url":{"type":"string"},"archived":{"type":"boolean"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"externalId":{"type":["string","null"]},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"website":{"type":["string","null"]},"taxId":{"type":["string","null"]},"creditLimit":{"type":"object","properties":{"amountCents":{"type":["integer","null"],"minimum":0,"maximum":2147483647},"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"}},"required":["amountCents","currencyCode"],"additionalProperties":false},"preferredUnitOfMeasure":{"type":"string","enum":["NoPreference","Metric","Imperial"]},"paymentTerms":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"externalId":{"type":["string","null"]}},"required":["id","name","externalId"],"additionalProperties":false},"costLedgerAccount":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"externalId":{"type":["string","null"]},"accountType":{"type":"string","enum":["ASSET","LIABILITY","EQUITY","REVENUE","EXPENSE"]}},"required":["id","name","externalId","accountType"],"additionalProperties":false},"supplierRepresentative":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":["string","null"]},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"}},"required":["id","firstName","lastName","externalId","archivedAt"],"additionalProperties":false},"address":{"type":"object","properties":{"street1":{"type":["string","null"]},"street2":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"zip":{"type":["string","null"]},"country":{"type":["string","null"]}},"required":["street1","street2","city","state","zip","country"],"additionalProperties":false},"contacts":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact"]},"id":{"type":"string","format":"uuid"},"contactKind":{"type":"string","enum":["customer","supplier"]},"displayName":{"type":"string"},"url":{"type":"string"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"archived":{"type":"boolean"},"externalId":{"type":["string","null"]},"name":{"type":"string"},"title":{"type":["string","null"]},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"mobilePhone":{"type":["string","null"]},"faxNumber":{"type":["string","null"]},"isEmergency":{"type":"boolean"},"documentTypes":{"type":"array","items":{"anyOf":[{"type":"string","enum":["AR_LETTER","PRICE_QUOTE","SALES_CONFIRMATION","INVOICE","CREDIT_NOTE"]},{"type":"string","enum":["PURCHASE_ORDERS","BILLS","MARKETING","LOGISTICS","WAREHOUSE","CALL_REPORTS"]}]}}},"required":["type","id","contactKind","displayName","url","parent","archived","externalId","name","title","email","phone","mobilePhone","faxNumber","isEmergency","documentTypes"],"additionalProperties":false}},"shipFromLocations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"externalId":{"type":["string","null"]},"street1":{"type":["string","null"]},"street2":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"zip":{"type":["string","null"]},"country":{"type":["string","null"]},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"defaultSupplierShippingInstructions":{"type":["string","null"]},"archived":{"type":"boolean"}},"required":["id","name","externalId","street1","street2","city","state","zip","country","email","phone","defaultSupplierShippingInstructions","archived"],"additionalProperties":false}}},"required":["type","id","displayName","url","archived","createdAt","updatedAt","externalId","email","phone","website","taxId","creditLimit","preferredUnitOfMeasure","paymentTerms","costLedgerAccount","supplierRepresentative","address","contacts","shipFromLocations"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["write_readiness"]},"operation":{"type":"string","enum":["warehouses.create","warehouses.update","warehouses.archive","warehouses.unarchive","shipping_options.create","shipping_options.update","shipping_options.archive","shipping_options.unarchive","reorder_points.create","tags.create","tags.update","tag_assignments.create","tag_assignments.delete","notes.create","notes.update","opportunities.create","opportunities.update","opportunities.close","opportunities.meta-upsert","contacts.create","contacts.update","customers.create","customers.update","customer_locations.create","customer_locations.update","customer_addresses.create","customer_addresses.update","suppliers.create","suppliers.update","supplier_ship_from_locations.create","supplier_ship_from_locations.update","products.create","products.update","products.archive","products.unarchive","product_packaging.create","products.suppliers.create","products.suppliers.delete","products.aliases.create","products.aliases.update","products.aliases.delete","product_families.aliases.create","product_families.aliases.update","product_families.aliases.delete","products.customer_part_numbers.create","products.customer_part_numbers.update","products.customer_part_numbers.delete","product_sds.update","product_documents.create","customer_documents.create","supplier_documents.create","purchase_order_documents.create","product_families.create","product_families.update","cost_book_entries.create","current_cost_sources.put","customers.archive","customers.unarchive","suppliers.archive","suppliers.unarchive","contacts.archive","contacts.unarchive","customer_addresses.archive","customer_addresses.unarchive","supplier_ship_from_locations.archive","supplier_ship_from_locations.unarchive","representatives.create","representatives.update","representatives.archive","representatives.unarchive","payment_terms.create","payment_terms.update","ledger_accounts.create","ledger_accounts.update"]},"status":{"type":"string","enum":["ready","blocked"]},"wouldWrite":{"type":"boolean","enum":[false]},"submit":{"type":"object","properties":{"method":{"type":"string","enum":["POST","PATCH","PUT","DELETE"]},"path":{"type":"string"},"query":{"type":"object","properties":{},"additionalProperties":false}},"required":["method","path","query"],"additionalProperties":false},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false},"checks":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["not_direct_ship","address_role_required","address_role_valid","already_assigned","already_exists","active_duplicate","ambiguous_external_id","ambiguous_natural_key","api_created","archived_target","archived_record","archive_blocked","account_type_locked","duplicate_candidate_found","duplicate_candidate_overflow","duplicate_check_clear","duplicate_check_not_needed","duplicate_contact","duplicate_customer","duplicate_customer_address","duplicate_customer_location","duplicate_note","duplicate_resolution_applied","duplicate_supplier","duplicate_supplier_ship_from_location","document_url_org_scoped","document_url_valid","upload_verified","sds_converged","idempotency_available","idempotency_key_required","idempotency_key_reused","idempotency_replay","idempotency_target_missing","income_statement_type_invalid","hard_identity_clear","nested_external_id_clear","commercial_references_valid","credit_denomination_mismatch","customer_service_representative_reference_active","ledger_account_reference_valid","payment_terms_reference_exists","sales_person_reference_active","supplier_representative_reference_active","duplicate_reference_identity","external_id_conflict","if_match_current","base_uom_transition_allowed","base_uom_transition_blocked","attribute_assignments_valid","attribute_assignments_invalid","selected_supplier_link","linked_records_available","natural_key_conflict","not_api_created","no_downstream_mutation","order_sensitive_update_allowed","order_sensitive_update_blocked","parent_available","cost_book_entry_blocked","cost_book_entry_valid","cost_book_reference_not_visible","unsupported_cost_book_uom","cost_uom_conversion_unavailable","cost_book_base_unavailable","cost_book_base_ambiguous","cost_ship_from_location_not_visible","cost_package_quantity_invalid","cost_component_invalid","cost_date_window_invalid","cost_date_overlap","cost_amount_overflow","cost_book_conflict","product_family_reference_active","product_packaging_reference_active","primary_child_available","primary_change_unsupported","reference_visibility_blocked","scope_authorized","stale_record","stale_cost_book_entry","supplier_reference_active","tag_applicable","tag_available","tag_exists","tag_found","tag_not_applicable","tag_not_found","type_immutable","type_known","type_required","target_active","target_available","target_not_found_or_not_visible","targets_visible","unsupported_linked_record","unsupported_profile_shape","variable_qty_valid","validation_failed","value_nonempty"]},"status":{"type":"string","enum":["passed","blocked"]},"message":{"type":"string"},"param":{"type":"string"}},"required":["code","status","message"],"additionalProperties":false}},"duplicateCandidates":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact","customer","supplier","customer_location","customer_address","supplier_ship_from_location","product","product_family","document"]},"readable":{"type":"boolean"},"version":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","product","purchase_order"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"matchReasons":{"type":"array","items":{"type":"string","enum":["name","email","externalId","address","code","product","url"]}},"readbackPath":{"type":"string"}},"required":["type","readable","matchReasons"],"additionalProperties":false}},"idempotency":{"type":"object","properties":{"required":{"type":"boolean"},"keyProvided":{"type":"boolean"},"wouldReplay":{"type":"boolean"}},"required":["required","keyProvided","wouldReplay"],"additionalProperties":false},"wouldChange":{"type":"object","properties":{"fieldNames":{"type":"array","items":{"type":"string"}},"values":{"type":"object","additionalProperties":{}}},"required":["fieldNames","values"],"additionalProperties":false},"impactAnalysis":{"type":"object","additionalProperties":{}},"requestId":{"type":"string"}},"required":["type","operation","status","wouldWrite","submit","verification","checks","duplicateCandidates","requestId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}]}}}},"201":{"description":"Supplier profile created.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["supplier"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"url":{"type":"string"},"archived":{"type":"boolean"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"externalId":{"type":["string","null"]},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"website":{"type":["string","null"]},"taxId":{"type":["string","null"]},"creditLimit":{"type":"object","properties":{"amountCents":{"type":["integer","null"],"minimum":0,"maximum":2147483647},"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"}},"required":["amountCents","currencyCode"],"additionalProperties":false},"preferredUnitOfMeasure":{"type":"string","enum":["NoPreference","Metric","Imperial"]},"paymentTerms":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"externalId":{"type":["string","null"]}},"required":["id","name","externalId"],"additionalProperties":false},"costLedgerAccount":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"externalId":{"type":["string","null"]},"accountType":{"type":"string","enum":["ASSET","LIABILITY","EQUITY","REVENUE","EXPENSE"]}},"required":["id","name","externalId","accountType"],"additionalProperties":false},"supplierRepresentative":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":["string","null"]},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"}},"required":["id","firstName","lastName","externalId","archivedAt"],"additionalProperties":false},"address":{"type":"object","properties":{"street1":{"type":["string","null"]},"street2":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"zip":{"type":["string","null"]},"country":{"type":["string","null"]}},"required":["street1","street2","city","state","zip","country"],"additionalProperties":false},"contacts":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact"]},"id":{"type":"string","format":"uuid"},"contactKind":{"type":"string","enum":["customer","supplier"]},"displayName":{"type":"string"},"url":{"type":"string"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"archived":{"type":"boolean"},"externalId":{"type":["string","null"]},"name":{"type":"string"},"title":{"type":["string","null"]},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"mobilePhone":{"type":["string","null"]},"faxNumber":{"type":["string","null"]},"isEmergency":{"type":"boolean"},"documentTypes":{"type":"array","items":{"anyOf":[{"type":"string","enum":["AR_LETTER","PRICE_QUOTE","SALES_CONFIRMATION","INVOICE","CREDIT_NOTE"]},{"type":"string","enum":["PURCHASE_ORDERS","BILLS","MARKETING","LOGISTICS","WAREHOUSE","CALL_REPORTS"]}]}}},"required":["type","id","contactKind","displayName","url","parent","archived","externalId","name","title","email","phone","mobilePhone","faxNumber","isEmergency","documentTypes"],"additionalProperties":false}},"shipFromLocations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"externalId":{"type":["string","null"]},"street1":{"type":["string","null"]},"street2":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"zip":{"type":["string","null"]},"country":{"type":["string","null"]},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"defaultSupplierShippingInstructions":{"type":["string","null"]},"archived":{"type":"boolean"}},"required":["id","name","externalId","street1","street2","city","state","zip","country","email","phone","defaultSupplierShippingInstructions","archived"],"additionalProperties":false}}},"required":["type","id","displayName","url","archived","createdAt","updatedAt","externalId","email","phone","website","taxId","creditLimit","preferredUnitOfMeasure","paymentTerms","costLedgerAccount","supplierRepresentative","address","contacts","shipFromLocations"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested parent or record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"409":{"description":"The write conflicted with an existing record, idempotency payload, or stale If-Match value.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/suppliers/{id}":{"get":{"operationId":"getPublicAPISupplier","summary":"Get a supplier","description":"Returns a safe read-only supplier detail DTO visible to the acting user.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":["suppliers:read","search:read"],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Supplier detail.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["supplier"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"url":{"type":"string"},"archived":{"type":"boolean"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"externalId":{"type":["string","null"]},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"website":{"type":["string","null"]},"taxId":{"type":["string","null"]},"creditLimit":{"type":"object","properties":{"amountCents":{"type":["integer","null"],"minimum":0,"maximum":2147483647},"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"}},"required":["amountCents","currencyCode"],"additionalProperties":false},"preferredUnitOfMeasure":{"type":"string","enum":["NoPreference","Metric","Imperial"]},"paymentTerms":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"externalId":{"type":["string","null"]}},"required":["id","name","externalId"],"additionalProperties":false},"costLedgerAccount":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"externalId":{"type":["string","null"]},"accountType":{"type":"string","enum":["ASSET","LIABILITY","EQUITY","REVENUE","EXPENSE"]}},"required":["id","name","externalId","accountType"],"additionalProperties":false},"supplierRepresentative":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":["string","null"]},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"}},"required":["id","firstName","lastName","externalId","archivedAt"],"additionalProperties":false},"address":{"type":"object","properties":{"street1":{"type":["string","null"]},"street2":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"zip":{"type":["string","null"]},"country":{"type":["string","null"]}},"required":["street1","street2","city","state","zip","country"],"additionalProperties":false},"contacts":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact"]},"id":{"type":"string","format":"uuid"},"contactKind":{"type":"string","enum":["customer","supplier"]},"displayName":{"type":"string"},"url":{"type":"string"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"archived":{"type":"boolean"},"externalId":{"type":["string","null"]},"name":{"type":"string"},"title":{"type":["string","null"]},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"mobilePhone":{"type":["string","null"]},"faxNumber":{"type":["string","null"]},"isEmergency":{"type":"boolean"},"documentTypes":{"type":"array","items":{"anyOf":[{"type":"string","enum":["AR_LETTER","PRICE_QUOTE","SALES_CONFIRMATION","INVOICE","CREDIT_NOTE"]},{"type":"string","enum":["PURCHASE_ORDERS","BILLS","MARKETING","LOGISTICS","WAREHOUSE","CALL_REPORTS"]}]}}},"required":["type","id","contactKind","displayName","url","parent","archived","externalId","name","title","email","phone","mobilePhone","faxNumber","isEmergency","documentTypes"],"additionalProperties":false}},"shipFromLocations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"externalId":{"type":["string","null"]},"street1":{"type":["string","null"]},"street2":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"zip":{"type":["string","null"]},"country":{"type":["string","null"]},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"defaultSupplierShippingInstructions":{"type":["string","null"]},"archived":{"type":"boolean"}},"required":["id","name","externalId","street1","street2","city","state","zip","country","email","phone","defaultSupplierShippingInstructions","archived"],"additionalProperties":false}}},"required":["type","id","displayName","url","archived","createdAt","updatedAt","externalId","email","phone","website","taxId","creditLimit","preferredUnitOfMeasure","paymentTerms","costLedgerAccount","supplierRepresentative","address","contacts","shipFromLocations"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updatePublicAPISupplierProfile","summary":"Update a supplier profile","description":"Updates bounded supplier profile fields. Omitted fields are preserved. Execute requests require If-Match. dryRun=true may omit If-Match and returns a blocked readiness check instead of writing.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"suppliers:write","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","enum":["true"]},"required":false,"name":"dryRun","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check."},"required":false,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check.","name":"If-Match","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":160},"externalId":{"type":["string","null"],"maxLength":120},"phone":{"type":["string","null"],"maxLength":80},"email":{"type":["string","null"],"maxLength":240},"website":{"type":["string","null"],"maxLength":240},"street1":{"type":["string","null"],"maxLength":240},"street2":{"type":["string","null"],"maxLength":240},"city":{"type":["string","null"],"maxLength":120},"state":{"type":["string","null"],"maxLength":80},"zip":{"type":["string","null"],"maxLength":40},"country":{"type":["string","null"],"maxLength":80},"taxId":{"type":["string","null"],"maxLength":120},"paymentTermsId":{"type":["string","null"],"format":"uuid"},"creditLimit":{"type":["object","null"],"properties":{"amountCents":{"type":["integer","null"],"minimum":0,"maximum":2147483647},"currencyCode":{"type":"string","minLength":3,"maxLength":3}},"required":["amountCents"],"additionalProperties":false},"preferredUnitOfMeasure":{"type":"string","enum":["NoPreference","Metric","Imperial"]},"costLedgerAccountId":{"type":["string","null"],"format":"uuid"},"supplierRepresentativeId":{"type":["string","null"],"format":"uuid"},"primaryShipFromAddress":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":160},"externalId":{"type":["string","null"],"maxLength":120},"street1":{"type":["string","null"],"maxLength":240},"street2":{"type":["string","null"],"maxLength":240},"city":{"type":["string","null"],"maxLength":120},"state":{"type":["string","null"],"maxLength":80},"zip":{"type":["string","null"],"maxLength":40},"country":{"type":["string","null"],"maxLength":80},"email":{"type":["string","null"],"maxLength":240},"phone":{"type":["string","null"],"maxLength":80},"defaultSupplierShippingInstructions":{"type":["string","null"],"maxLength":2000}},"additionalProperties":false}},"additionalProperties":false}}}},"responses":{"200":{"description":"Updated supplier profile, or dryRun returned write readiness.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["supplier"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"url":{"type":"string"},"archived":{"type":"boolean"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"externalId":{"type":["string","null"]},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"website":{"type":["string","null"]},"taxId":{"type":["string","null"]},"creditLimit":{"type":"object","properties":{"amountCents":{"type":["integer","null"],"minimum":0,"maximum":2147483647},"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"}},"required":["amountCents","currencyCode"],"additionalProperties":false},"preferredUnitOfMeasure":{"type":"string","enum":["NoPreference","Metric","Imperial"]},"paymentTerms":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"externalId":{"type":["string","null"]}},"required":["id","name","externalId"],"additionalProperties":false},"costLedgerAccount":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"externalId":{"type":["string","null"]},"accountType":{"type":"string","enum":["ASSET","LIABILITY","EQUITY","REVENUE","EXPENSE"]}},"required":["id","name","externalId","accountType"],"additionalProperties":false},"supplierRepresentative":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":["string","null"]},"externalId":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"}},"required":["id","firstName","lastName","externalId","archivedAt"],"additionalProperties":false},"address":{"type":"object","properties":{"street1":{"type":["string","null"]},"street2":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"zip":{"type":["string","null"]},"country":{"type":["string","null"]}},"required":["street1","street2","city","state","zip","country"],"additionalProperties":false},"contacts":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact"]},"id":{"type":"string","format":"uuid"},"contactKind":{"type":"string","enum":["customer","supplier"]},"displayName":{"type":"string"},"url":{"type":"string"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"archived":{"type":"boolean"},"externalId":{"type":["string","null"]},"name":{"type":"string"},"title":{"type":["string","null"]},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"mobilePhone":{"type":["string","null"]},"faxNumber":{"type":["string","null"]},"isEmergency":{"type":"boolean"},"documentTypes":{"type":"array","items":{"anyOf":[{"type":"string","enum":["AR_LETTER","PRICE_QUOTE","SALES_CONFIRMATION","INVOICE","CREDIT_NOTE"]},{"type":"string","enum":["PURCHASE_ORDERS","BILLS","MARKETING","LOGISTICS","WAREHOUSE","CALL_REPORTS"]}]}}},"required":["type","id","contactKind","displayName","url","parent","archived","externalId","name","title","email","phone","mobilePhone","faxNumber","isEmergency","documentTypes"],"additionalProperties":false}},"shipFromLocations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"externalId":{"type":["string","null"]},"street1":{"type":["string","null"]},"street2":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"zip":{"type":["string","null"]},"country":{"type":["string","null"]},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"defaultSupplierShippingInstructions":{"type":["string","null"]},"archived":{"type":"boolean"}},"required":["id","name","externalId","street1","street2","city","state","zip","country","email","phone","defaultSupplierShippingInstructions","archived"],"additionalProperties":false}}},"required":["type","id","displayName","url","archived","createdAt","updatedAt","externalId","email","phone","website","taxId","creditLimit","preferredUnitOfMeasure","paymentTerms","costLedgerAccount","supplierRepresentative","address","contacts","shipFromLocations"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["write_readiness"]},"operation":{"type":"string","enum":["warehouses.create","warehouses.update","warehouses.archive","warehouses.unarchive","shipping_options.create","shipping_options.update","shipping_options.archive","shipping_options.unarchive","reorder_points.create","tags.create","tags.update","tag_assignments.create","tag_assignments.delete","notes.create","notes.update","opportunities.create","opportunities.update","opportunities.close","opportunities.meta-upsert","contacts.create","contacts.update","customers.create","customers.update","customer_locations.create","customer_locations.update","customer_addresses.create","customer_addresses.update","suppliers.create","suppliers.update","supplier_ship_from_locations.create","supplier_ship_from_locations.update","products.create","products.update","products.archive","products.unarchive","product_packaging.create","products.suppliers.create","products.suppliers.delete","products.aliases.create","products.aliases.update","products.aliases.delete","product_families.aliases.create","product_families.aliases.update","product_families.aliases.delete","products.customer_part_numbers.create","products.customer_part_numbers.update","products.customer_part_numbers.delete","product_sds.update","product_documents.create","customer_documents.create","supplier_documents.create","purchase_order_documents.create","product_families.create","product_families.update","cost_book_entries.create","current_cost_sources.put","customers.archive","customers.unarchive","suppliers.archive","suppliers.unarchive","contacts.archive","contacts.unarchive","customer_addresses.archive","customer_addresses.unarchive","supplier_ship_from_locations.archive","supplier_ship_from_locations.unarchive","representatives.create","representatives.update","representatives.archive","representatives.unarchive","payment_terms.create","payment_terms.update","ledger_accounts.create","ledger_accounts.update"]},"status":{"type":"string","enum":["ready","blocked"]},"wouldWrite":{"type":"boolean","enum":[false]},"submit":{"type":"object","properties":{"method":{"type":"string","enum":["POST","PATCH","PUT","DELETE"]},"path":{"type":"string"},"query":{"type":"object","properties":{},"additionalProperties":false}},"required":["method","path","query"],"additionalProperties":false},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false},"checks":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["not_direct_ship","address_role_required","address_role_valid","already_assigned","already_exists","active_duplicate","ambiguous_external_id","ambiguous_natural_key","api_created","archived_target","archived_record","archive_blocked","account_type_locked","duplicate_candidate_found","duplicate_candidate_overflow","duplicate_check_clear","duplicate_check_not_needed","duplicate_contact","duplicate_customer","duplicate_customer_address","duplicate_customer_location","duplicate_note","duplicate_resolution_applied","duplicate_supplier","duplicate_supplier_ship_from_location","document_url_org_scoped","document_url_valid","upload_verified","sds_converged","idempotency_available","idempotency_key_required","idempotency_key_reused","idempotency_replay","idempotency_target_missing","income_statement_type_invalid","hard_identity_clear","nested_external_id_clear","commercial_references_valid","credit_denomination_mismatch","customer_service_representative_reference_active","ledger_account_reference_valid","payment_terms_reference_exists","sales_person_reference_active","supplier_representative_reference_active","duplicate_reference_identity","external_id_conflict","if_match_current","base_uom_transition_allowed","base_uom_transition_blocked","attribute_assignments_valid","attribute_assignments_invalid","selected_supplier_link","linked_records_available","natural_key_conflict","not_api_created","no_downstream_mutation","order_sensitive_update_allowed","order_sensitive_update_blocked","parent_available","cost_book_entry_blocked","cost_book_entry_valid","cost_book_reference_not_visible","unsupported_cost_book_uom","cost_uom_conversion_unavailable","cost_book_base_unavailable","cost_book_base_ambiguous","cost_ship_from_location_not_visible","cost_package_quantity_invalid","cost_component_invalid","cost_date_window_invalid","cost_date_overlap","cost_amount_overflow","cost_book_conflict","product_family_reference_active","product_packaging_reference_active","primary_child_available","primary_change_unsupported","reference_visibility_blocked","scope_authorized","stale_record","stale_cost_book_entry","supplier_reference_active","tag_applicable","tag_available","tag_exists","tag_found","tag_not_applicable","tag_not_found","type_immutable","type_known","type_required","target_active","target_available","target_not_found_or_not_visible","targets_visible","unsupported_linked_record","unsupported_profile_shape","variable_qty_valid","validation_failed","value_nonempty"]},"status":{"type":"string","enum":["passed","blocked"]},"message":{"type":"string"},"param":{"type":"string"}},"required":["code","status","message"],"additionalProperties":false}},"duplicateCandidates":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact","customer","supplier","customer_location","customer_address","supplier_ship_from_location","product","product_family","document"]},"readable":{"type":"boolean"},"version":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","product","purchase_order"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"matchReasons":{"type":"array","items":{"type":"string","enum":["name","email","externalId","address","code","product","url"]}},"readbackPath":{"type":"string"}},"required":["type","readable","matchReasons"],"additionalProperties":false}},"idempotency":{"type":"object","properties":{"required":{"type":"boolean"},"keyProvided":{"type":"boolean"},"wouldReplay":{"type":"boolean"}},"required":["required","keyProvided","wouldReplay"],"additionalProperties":false},"wouldChange":{"type":"object","properties":{"fieldNames":{"type":"array","items":{"type":"string"}},"values":{"type":"object","additionalProperties":{}}},"required":["fieldNames","values"],"additionalProperties":false},"impactAnalysis":{"type":"object","additionalProperties":{}},"requestId":{"type":"string"}},"required":["type","operation","status","wouldWrite","submit","verification","checks","duplicateCandidates","requestId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}]}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested parent or record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"409":{"description":"The write conflicted with an existing record, idempotency payload, or stale If-Match value.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/suppliers/{id}/documents":{"get":{"operationId":"listPublicAPISupplierDocuments","summary":"List supplier documents","description":"Returns attached documents on one visible supplier, omitting dismissed rows. Document files are user-attached files and may contain sensitive commercial or tax data; ShelfCycle bucket files are returned as 15-minute signed read URLs.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":["suppliers:read","search:read"],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Supplier attached documents.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"documents":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["document"]},"id":{"type":"string","format":"uuid"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"urlClass":{"type":"string","enum":["shelfcycle","external"]},"access":{"type":"object","properties":{"mode":{"type":"string","enum":["signed","raw","unavailable"]},"url":{"type":"string"},"expiresAt":{"type":"string","format":"date-time"}},"required":["mode"],"additionalProperties":false}},"required":["type","id","fileName","createdAt","urlClass","access"],"additionalProperties":false}},"truncated":{"type":"boolean"}},"required":["documents","truncated"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}},"post":{"operationId":"createPublicAPISupplierDocument","summary":"Attach a supplier document","description":"Creates an attached document on a visible active supplier. Execute requests require Idempotency-Key. dryRun=true may omit Idempotency-Key and returns a blocked readiness check instead of writing. The body may be an existing external/legacy link or data.document from the upload-grant route. New API-upload descriptors are HEAD-verified only after replay and duplicate checks. This creates one Document row and one idempotency identity only. It does not transport binary files through the application, mutate the supplier, delete documents, or touch tax, payment, ledger, order, inventory, or accounting records. A valid API-upload descriptor may be passed between keys in the same organization. documents:upload is required only to mint the grant; association and SDS routes require their documented target write scope and current ShelfCycle access. Descriptor possession grants no read access. API-upload association create and replay responses omit signed access unless the calling key also has the target read scope and live view permission.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"suppliers:write","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","enum":["true"]},"required":false,"name":"dryRun","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Required for execute requests. dryRun=true may omit this header and receive an idempotency_key_required check."},"required":false,"description":"Required for execute requests. dryRun=true may omit this header and receive an idempotency_key_required check.","name":"Idempotency-Key","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"fileName":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[^\\u0000-\\u001F\\u007F]*$"},"url":{"type":"string","minLength":1,"maxLength":2048}},"required":["fileName","url"],"additionalProperties":false}}}},"responses":{"200":{"description":"Idempotent replay returned the existing supplier document, or dryRun returned write readiness.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["document"]},"id":{"type":"string","format":"uuid"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"urlClass":{"type":"string","enum":["shelfcycle","external"]},"access":{"type":"object","properties":{"mode":{"type":"string","enum":["signed","raw","unavailable"]},"url":{"type":"string"},"expiresAt":{"type":"string","format":"date-time"}},"required":["mode"],"additionalProperties":false},"idempotencyStatus":{"type":"string","enum":["created","replayed"]},"integrity":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","enum":["verified"]},"checksumSha256":{"type":"string","pattern":"^[a-f0-9]{64}$","description":"Lowercase SHA-256 matched by the association-time storage HEAD check."},"sizeBytes":{"type":"integer","exclusiveMinimum":0,"description":"Storage-reported object size verified at association time."},"contentType":{"type":"string","minLength":1,"description":"Storage-reported canonical content type verified at association time."},"verifiedAt":{"type":"string","format":"date-time","description":"Time ShelfCycle completed the association verification."}},"required":["status","checksumSha256","sizeBytes","contentType","verifiedAt"],"additionalProperties":false,"description":"Durable association receipt; it is not malware scanning, content interpretation, or perpetual-retention proof."},{"type":"object","properties":{"status":{"type":"string","enum":["not_verified"]},"reason":{"type":"string","enum":["external_or_legacy_link"]}},"required":["status","reason"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","enum":["unavailable"]},"reason":{"type":"string","enum":["legacy_receipt_not_recorded"]}},"required":["status","reason"],"additionalProperties":false}]}},"required":["type","id","fileName","createdAt","urlClass","access","idempotencyStatus","integrity"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["write_readiness"]},"operation":{"type":"string","enum":["warehouses.create","warehouses.update","warehouses.archive","warehouses.unarchive","shipping_options.create","shipping_options.update","shipping_options.archive","shipping_options.unarchive","reorder_points.create","tags.create","tags.update","tag_assignments.create","tag_assignments.delete","notes.create","notes.update","opportunities.create","opportunities.update","opportunities.close","opportunities.meta-upsert","contacts.create","contacts.update","customers.create","customers.update","customer_locations.create","customer_locations.update","customer_addresses.create","customer_addresses.update","suppliers.create","suppliers.update","supplier_ship_from_locations.create","supplier_ship_from_locations.update","products.create","products.update","products.archive","products.unarchive","product_packaging.create","products.suppliers.create","products.suppliers.delete","products.aliases.create","products.aliases.update","products.aliases.delete","product_families.aliases.create","product_families.aliases.update","product_families.aliases.delete","products.customer_part_numbers.create","products.customer_part_numbers.update","products.customer_part_numbers.delete","product_sds.update","product_documents.create","customer_documents.create","supplier_documents.create","purchase_order_documents.create","product_families.create","product_families.update","cost_book_entries.create","current_cost_sources.put","customers.archive","customers.unarchive","suppliers.archive","suppliers.unarchive","contacts.archive","contacts.unarchive","customer_addresses.archive","customer_addresses.unarchive","supplier_ship_from_locations.archive","supplier_ship_from_locations.unarchive","representatives.create","representatives.update","representatives.archive","representatives.unarchive","payment_terms.create","payment_terms.update","ledger_accounts.create","ledger_accounts.update"]},"status":{"type":"string","enum":["ready","blocked"]},"wouldWrite":{"type":"boolean","enum":[false]},"submit":{"type":"object","properties":{"method":{"type":"string","enum":["POST","PATCH","PUT","DELETE"]},"path":{"type":"string"},"query":{"type":"object","properties":{},"additionalProperties":false}},"required":["method","path","query"],"additionalProperties":false},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false},"checks":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["not_direct_ship","address_role_required","address_role_valid","already_assigned","already_exists","active_duplicate","ambiguous_external_id","ambiguous_natural_key","api_created","archived_target","archived_record","archive_blocked","account_type_locked","duplicate_candidate_found","duplicate_candidate_overflow","duplicate_check_clear","duplicate_check_not_needed","duplicate_contact","duplicate_customer","duplicate_customer_address","duplicate_customer_location","duplicate_note","duplicate_resolution_applied","duplicate_supplier","duplicate_supplier_ship_from_location","document_url_org_scoped","document_url_valid","upload_verified","sds_converged","idempotency_available","idempotency_key_required","idempotency_key_reused","idempotency_replay","idempotency_target_missing","income_statement_type_invalid","hard_identity_clear","nested_external_id_clear","commercial_references_valid","credit_denomination_mismatch","customer_service_representative_reference_active","ledger_account_reference_valid","payment_terms_reference_exists","sales_person_reference_active","supplier_representative_reference_active","duplicate_reference_identity","external_id_conflict","if_match_current","base_uom_transition_allowed","base_uom_transition_blocked","attribute_assignments_valid","attribute_assignments_invalid","selected_supplier_link","linked_records_available","natural_key_conflict","not_api_created","no_downstream_mutation","order_sensitive_update_allowed","order_sensitive_update_blocked","parent_available","cost_book_entry_blocked","cost_book_entry_valid","cost_book_reference_not_visible","unsupported_cost_book_uom","cost_uom_conversion_unavailable","cost_book_base_unavailable","cost_book_base_ambiguous","cost_ship_from_location_not_visible","cost_package_quantity_invalid","cost_component_invalid","cost_date_window_invalid","cost_date_overlap","cost_amount_overflow","cost_book_conflict","product_family_reference_active","product_packaging_reference_active","primary_child_available","primary_change_unsupported","reference_visibility_blocked","scope_authorized","stale_record","stale_cost_book_entry","supplier_reference_active","tag_applicable","tag_available","tag_exists","tag_found","tag_not_applicable","tag_not_found","type_immutable","type_known","type_required","target_active","target_available","target_not_found_or_not_visible","targets_visible","unsupported_linked_record","unsupported_profile_shape","variable_qty_valid","validation_failed","value_nonempty"]},"status":{"type":"string","enum":["passed","blocked"]},"message":{"type":"string"},"param":{"type":"string"}},"required":["code","status","message"],"additionalProperties":false}},"duplicateCandidates":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact","customer","supplier","customer_location","customer_address","supplier_ship_from_location","product","product_family","document"]},"readable":{"type":"boolean"},"version":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","product","purchase_order"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"matchReasons":{"type":"array","items":{"type":"string","enum":["name","email","externalId","address","code","product","url"]}},"readbackPath":{"type":"string"}},"required":["type","readable","matchReasons"],"additionalProperties":false}},"idempotency":{"type":"object","properties":{"required":{"type":"boolean"},"keyProvided":{"type":"boolean"},"wouldReplay":{"type":"boolean"}},"required":["required","keyProvided","wouldReplay"],"additionalProperties":false},"wouldChange":{"type":"object","properties":{"fieldNames":{"type":"array","items":{"type":"string"}},"values":{"type":"object","additionalProperties":{}}},"required":["fieldNames","values"],"additionalProperties":false},"impactAnalysis":{"type":"object","additionalProperties":{}},"requestId":{"type":"string"}},"required":["type","operation","status","wouldWrite","submit","verification","checks","duplicateCandidates","requestId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}]},"examples":{"verified-api-upload-replay":{"summary":"Exact replay returns the stored association receipt without another storage check","value":{"data":{"type":"document","id":"11111111-1111-4111-8111-111111111111","fileName":"Supplier Confirmation.pdf","createdAt":"2026-08-11T12:00:00.000Z","urlClass":"shelfcycle","access":{"mode":"unavailable"},"idempotencyStatus":"replayed","integrity":{"status":"verified","checksumSha256":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","sizeBytes":4096,"contentType":"application/pdf","verifiedAt":"2026-08-11T12:00:00.000Z"}}}}}}}},"201":{"description":"Supplier document created.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["document"]},"id":{"type":"string","format":"uuid"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"urlClass":{"type":"string","enum":["shelfcycle","external"]},"access":{"type":"object","properties":{"mode":{"type":"string","enum":["signed","raw","unavailable"]},"url":{"type":"string"},"expiresAt":{"type":"string","format":"date-time"}},"required":["mode"],"additionalProperties":false},"idempotencyStatus":{"type":"string","enum":["created","replayed"]},"integrity":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","enum":["verified"]},"checksumSha256":{"type":"string","pattern":"^[a-f0-9]{64}$","description":"Lowercase SHA-256 matched by the association-time storage HEAD check."},"sizeBytes":{"type":"integer","exclusiveMinimum":0,"description":"Storage-reported object size verified at association time."},"contentType":{"type":"string","minLength":1,"description":"Storage-reported canonical content type verified at association time."},"verifiedAt":{"type":"string","format":"date-time","description":"Time ShelfCycle completed the association verification."}},"required":["status","checksumSha256","sizeBytes","contentType","verifiedAt"],"additionalProperties":false,"description":"Durable association receipt; it is not malware scanning, content interpretation, or perpetual-retention proof."},{"type":"object","properties":{"status":{"type":"string","enum":["not_verified"]},"reason":{"type":"string","enum":["external_or_legacy_link"]}},"required":["status","reason"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","enum":["unavailable"]},"reason":{"type":"string","enum":["legacy_receipt_not_recorded"]}},"required":["status","reason"],"additionalProperties":false}]}},"required":["type","id","fileName","createdAt","urlClass","access","idempotencyStatus","integrity"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},"examples":{"verified-api-upload":{"summary":"API-upload association with a durable integrity receipt","value":{"data":{"type":"document","id":"11111111-1111-4111-8111-111111111111","fileName":"Supplier Confirmation.pdf","createdAt":"2026-08-11T12:00:00.000Z","urlClass":"shelfcycle","access":{"mode":"unavailable"},"idempotencyStatus":"created","integrity":{"status":"verified","checksumSha256":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","sizeBytes":4096,"contentType":"application/pdf","verifiedAt":"2026-08-11T12:00:00.000Z"}}}}}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested parent or record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"409":{"description":"The write conflicted with an existing record, idempotency payload, or stale If-Match value.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/reference/suppliers":{"get":{"operationId":"listPublicAPISupplierReferences","summary":"Page active supplier references","description":"Pages active supplier matching hints for local agent caches. This is not a supplier detail export, contact export, incremental sync, archived export, or write authorization surface. Clients must fetch exact detail endpoints before writes.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"company-reference:read","parameters":[{"schema":{"type":"string"},"required":false,"name":"limit","in":"query"},{"schema":{"type":"string"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"string","enum":["false"]},"required":false,"name":"includeArchived","in":"query"}],"responses":{"200":{"description":"Active supplier reference rows and cursor metadata.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"externalId":{"type":["string","null"]},"alternateNames":{"type":"array","items":{"type":"string"}},"website":{"type":["string","null"]},"emailDomains":{"type":"array","items":{"type":"string"}},"phone":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"country":{"type":["string","null"]},"status":{"type":"string","enum":["active"]},"updatedAt":{"type":"string","format":"date-time"},"url":{"type":"string"},"type":{"type":"string","enum":["supplier"]}},"required":["id","displayName","externalId","alternateNames","website","emailDomains","phone","city","state","country","status","updatedAt","url","type"],"additionalProperties":false}},"meta":{"type":"object","properties":{"requestId":{"type":"string"},"mode":{"type":"string","enum":["active_reference_directory"]},"resource":{"type":"string","enum":["customers","suppliers"]},"limit":{"type":"integer"},"hasMore":{"type":"boolean"},"truncated":{"type":"boolean"},"nextCursor":{"type":["string","null"]},"generatedAt":{"type":"string","format":"date-time"},"sort":{"type":"string","enum":["id_asc"]},"filters":{"type":"object","properties":{"includeArchived":{"type":"boolean","enum":[false]}},"required":["includeArchived"],"additionalProperties":false}},"required":["requestId","mode","resource","limit","hasMore","truncated","nextCursor","generatedAt","sort","filters"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/suppliers/{id}/ship-from-locations":{"get":{"operationId":"listPublicAPISupplierShipFromLocations","summary":"List supplier ship-from locations","description":"Pages active ship-from locations under one visible active supplier. This is parent scoped and not a broad supplier address export.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":["suppliers:read","search:read"],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string"},"required":false,"name":"limit","in":"query"},{"schema":{"type":"string","maxLength":2048},"required":false,"name":"cursor","in":"query"}],"responses":{"200":{"description":"Parent-scoped active supplier ship-from locations.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["supplier_ship_from_location"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"apiPath":{"type":"string"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"archived":{"type":"boolean"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"externalId":{"type":["string","null"]},"name":{"type":"string"},"street1":{"type":["string","null"]},"street2":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"zip":{"type":["string","null"]},"country":{"type":["string","null"]},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"defaultSupplierShippingInstructions":{"type":["string","null"]},"requestedVia":{"type":"object","properties":{"type":{"type":"string","enum":["api_key"]},"id":{"type":"string","format":"uuid"},"purpose":{"type":["string","null"]}},"required":["type","id","purpose"],"additionalProperties":false},"idempotencyStatus":{"type":"string","enum":["created","replayed","updated","fetched"]}},"required":["type","id","displayName","apiPath","parent","archived","createdAt","updatedAt","externalId","name","street1","street2","city","state","zip","country","email","phone","defaultSupplierShippingInstructions","requestedVia","idempotencyStatus"],"additionalProperties":false}},"meta":{"type":"object","properties":{"requestId":{"type":"string"},"mode":{"type":"string","enum":["parent_scoped_child_list"]},"resource":{"type":"string","enum":["customer_locations","customer_addresses","supplier_ship_from_locations"]},"limit":{"type":"integer"},"hasMore":{"type":"boolean"},"truncated":{"type":"boolean"},"nextCursor":{"type":["string","null"]},"generatedAt":{"type":"string","format":"date-time"},"sort":{"type":"string","enum":["id_asc"]},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false}},"required":["requestId","mode","resource","limit","hasMore","truncated","nextCursor","generatedAt","sort","parent"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}},"post":{"operationId":"createPublicAPISupplierShipFromLocation","summary":"Create a supplier ship-from location","description":"Creates a ship-from location under a visible active supplier. Execute requests require Idempotency-Key. dryRun=true may omit Idempotency-Key and returns a blocked readiness check instead of writing.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"suppliers:write","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","enum":["true"]},"required":false,"name":"dryRun","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Required for execute requests. dryRun=true may omit this header and receive an idempotency_key_required check."},"required":false,"description":"Required for execute requests. dryRun=true may omit this header and receive an idempotency_key_required check.","name":"Idempotency-Key","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"street1":{"type":["string","null"],"maxLength":240},"street2":{"type":["string","null"],"maxLength":240},"city":{"type":["string","null"],"maxLength":120},"state":{"type":["string","null"],"maxLength":80},"zip":{"type":["string","null"],"maxLength":40},"country":{"type":["string","null"],"maxLength":80},"name":{"type":"string","minLength":1,"maxLength":160},"externalId":{"type":["string","null"],"maxLength":120},"email":{"type":["string","null"],"maxLength":240},"phone":{"type":["string","null"],"maxLength":80},"defaultSupplierShippingInstructions":{"type":["string","null"],"maxLength":2000},"duplicateResolution":{"type":"string","enum":["create_distinct"]}},"required":["name"],"additionalProperties":false}}}},"responses":{"200":{"description":"Idempotent replay returned the existing supplier ship-from location, or dryRun returned write readiness.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["supplier_ship_from_location"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"apiPath":{"type":"string"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"archived":{"type":"boolean"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"externalId":{"type":["string","null"]},"name":{"type":"string"},"street1":{"type":["string","null"]},"street2":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"zip":{"type":["string","null"]},"country":{"type":["string","null"]},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"defaultSupplierShippingInstructions":{"type":["string","null"]},"requestedVia":{"type":"object","properties":{"type":{"type":"string","enum":["api_key"]},"id":{"type":"string","format":"uuid"},"purpose":{"type":["string","null"]}},"required":["type","id","purpose"],"additionalProperties":false},"idempotencyStatus":{"type":"string","enum":["created","replayed","updated","fetched"]}},"required":["type","id","displayName","apiPath","parent","archived","createdAt","updatedAt","externalId","name","street1","street2","city","state","zip","country","email","phone","defaultSupplierShippingInstructions","requestedVia","idempotencyStatus"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["write_readiness"]},"operation":{"type":"string","enum":["warehouses.create","warehouses.update","warehouses.archive","warehouses.unarchive","shipping_options.create","shipping_options.update","shipping_options.archive","shipping_options.unarchive","reorder_points.create","tags.create","tags.update","tag_assignments.create","tag_assignments.delete","notes.create","notes.update","opportunities.create","opportunities.update","opportunities.close","opportunities.meta-upsert","contacts.create","contacts.update","customers.create","customers.update","customer_locations.create","customer_locations.update","customer_addresses.create","customer_addresses.update","suppliers.create","suppliers.update","supplier_ship_from_locations.create","supplier_ship_from_locations.update","products.create","products.update","products.archive","products.unarchive","product_packaging.create","products.suppliers.create","products.suppliers.delete","products.aliases.create","products.aliases.update","products.aliases.delete","product_families.aliases.create","product_families.aliases.update","product_families.aliases.delete","products.customer_part_numbers.create","products.customer_part_numbers.update","products.customer_part_numbers.delete","product_sds.update","product_documents.create","customer_documents.create","supplier_documents.create","purchase_order_documents.create","product_families.create","product_families.update","cost_book_entries.create","current_cost_sources.put","customers.archive","customers.unarchive","suppliers.archive","suppliers.unarchive","contacts.archive","contacts.unarchive","customer_addresses.archive","customer_addresses.unarchive","supplier_ship_from_locations.archive","supplier_ship_from_locations.unarchive","representatives.create","representatives.update","representatives.archive","representatives.unarchive","payment_terms.create","payment_terms.update","ledger_accounts.create","ledger_accounts.update"]},"status":{"type":"string","enum":["ready","blocked"]},"wouldWrite":{"type":"boolean","enum":[false]},"submit":{"type":"object","properties":{"method":{"type":"string","enum":["POST","PATCH","PUT","DELETE"]},"path":{"type":"string"},"query":{"type":"object","properties":{},"additionalProperties":false}},"required":["method","path","query"],"additionalProperties":false},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false},"checks":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["not_direct_ship","address_role_required","address_role_valid","already_assigned","already_exists","active_duplicate","ambiguous_external_id","ambiguous_natural_key","api_created","archived_target","archived_record","archive_blocked","account_type_locked","duplicate_candidate_found","duplicate_candidate_overflow","duplicate_check_clear","duplicate_check_not_needed","duplicate_contact","duplicate_customer","duplicate_customer_address","duplicate_customer_location","duplicate_note","duplicate_resolution_applied","duplicate_supplier","duplicate_supplier_ship_from_location","document_url_org_scoped","document_url_valid","upload_verified","sds_converged","idempotency_available","idempotency_key_required","idempotency_key_reused","idempotency_replay","idempotency_target_missing","income_statement_type_invalid","hard_identity_clear","nested_external_id_clear","commercial_references_valid","credit_denomination_mismatch","customer_service_representative_reference_active","ledger_account_reference_valid","payment_terms_reference_exists","sales_person_reference_active","supplier_representative_reference_active","duplicate_reference_identity","external_id_conflict","if_match_current","base_uom_transition_allowed","base_uom_transition_blocked","attribute_assignments_valid","attribute_assignments_invalid","selected_supplier_link","linked_records_available","natural_key_conflict","not_api_created","no_downstream_mutation","order_sensitive_update_allowed","order_sensitive_update_blocked","parent_available","cost_book_entry_blocked","cost_book_entry_valid","cost_book_reference_not_visible","unsupported_cost_book_uom","cost_uom_conversion_unavailable","cost_book_base_unavailable","cost_book_base_ambiguous","cost_ship_from_location_not_visible","cost_package_quantity_invalid","cost_component_invalid","cost_date_window_invalid","cost_date_overlap","cost_amount_overflow","cost_book_conflict","product_family_reference_active","product_packaging_reference_active","primary_child_available","primary_change_unsupported","reference_visibility_blocked","scope_authorized","stale_record","stale_cost_book_entry","supplier_reference_active","tag_applicable","tag_available","tag_exists","tag_found","tag_not_applicable","tag_not_found","type_immutable","type_known","type_required","target_active","target_available","target_not_found_or_not_visible","targets_visible","unsupported_linked_record","unsupported_profile_shape","variable_qty_valid","validation_failed","value_nonempty"]},"status":{"type":"string","enum":["passed","blocked"]},"message":{"type":"string"},"param":{"type":"string"}},"required":["code","status","message"],"additionalProperties":false}},"duplicateCandidates":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact","customer","supplier","customer_location","customer_address","supplier_ship_from_location","product","product_family","document"]},"readable":{"type":"boolean"},"version":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","product","purchase_order"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"matchReasons":{"type":"array","items":{"type":"string","enum":["name","email","externalId","address","code","product","url"]}},"readbackPath":{"type":"string"}},"required":["type","readable","matchReasons"],"additionalProperties":false}},"idempotency":{"type":"object","properties":{"required":{"type":"boolean"},"keyProvided":{"type":"boolean"},"wouldReplay":{"type":"boolean"}},"required":["required","keyProvided","wouldReplay"],"additionalProperties":false},"wouldChange":{"type":"object","properties":{"fieldNames":{"type":"array","items":{"type":"string"}},"values":{"type":"object","additionalProperties":{}}},"required":["fieldNames","values"],"additionalProperties":false},"impactAnalysis":{"type":"object","additionalProperties":{}},"requestId":{"type":"string"}},"required":["type","operation","status","wouldWrite","submit","verification","checks","duplicateCandidates","requestId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}]}}}},"201":{"description":"Supplier ship-from location created.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["supplier_ship_from_location"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"apiPath":{"type":"string"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"archived":{"type":"boolean"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"externalId":{"type":["string","null"]},"name":{"type":"string"},"street1":{"type":["string","null"]},"street2":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"zip":{"type":["string","null"]},"country":{"type":["string","null"]},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"defaultSupplierShippingInstructions":{"type":["string","null"]},"requestedVia":{"type":"object","properties":{"type":{"type":"string","enum":["api_key"]},"id":{"type":"string","format":"uuid"},"purpose":{"type":["string","null"]}},"required":["type","id","purpose"],"additionalProperties":false},"idempotencyStatus":{"type":"string","enum":["created","replayed","updated","fetched"]}},"required":["type","id","displayName","apiPath","parent","archived","createdAt","updatedAt","externalId","name","street1","street2","city","state","zip","country","email","phone","defaultSupplierShippingInstructions","requestedVia","idempotencyStatus"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested parent or record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"409":{"description":"The write conflicted with an existing record, idempotency payload, or stale If-Match value.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/suppliers/{id}/ship-from-locations/{locationId}":{"get":{"operationId":"getPublicAPISupplierShipFromLocation","summary":"Get a supplier ship-from location","description":"Returns one ship-from location only when it belongs to the visible supplier parent.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":["suppliers:read","search:read"],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"locationId","in":"path"}],"responses":{"200":{"description":"Supplier ship-from location detail.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["supplier_ship_from_location"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"apiPath":{"type":"string"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"archived":{"type":"boolean"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"externalId":{"type":["string","null"]},"name":{"type":"string"},"street1":{"type":["string","null"]},"street2":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"zip":{"type":["string","null"]},"country":{"type":["string","null"]},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"defaultSupplierShippingInstructions":{"type":["string","null"]},"requestedVia":{"type":"object","properties":{"type":{"type":"string","enum":["api_key"]},"id":{"type":"string","format":"uuid"},"purpose":{"type":["string","null"]}},"required":["type","id","purpose"],"additionalProperties":false},"idempotencyStatus":{"type":"string","enum":["created","replayed","updated","fetched"]}},"required":["type","id","displayName","apiPath","parent","archived","createdAt","updatedAt","externalId","name","street1","street2","city","state","zip","country","email","phone","defaultSupplierShippingInstructions","requestedVia","idempotencyStatus"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updatePublicAPISupplierShipFromLocation","summary":"Update a supplier ship-from location","description":"Updates safe supplier ship-from location fields. Execute requests require If-Match. dryRun=true may omit If-Match and returns a blocked readiness check instead of writing.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"suppliers:write","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"locationId","in":"path"},{"schema":{"type":"string","enum":["true"]},"required":false,"name":"dryRun","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check."},"required":false,"description":"Required for execute requests. dryRun=true may omit this header and receive a stale_record readiness check.","name":"If-Match","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"street1":{"type":["string","null"],"maxLength":240},"street2":{"type":["string","null"],"maxLength":240},"city":{"type":["string","null"],"maxLength":120},"state":{"type":["string","null"],"maxLength":80},"zip":{"type":["string","null"],"maxLength":40},"country":{"type":["string","null"],"maxLength":80},"name":{"type":"string","minLength":1,"maxLength":160},"externalId":{"type":["string","null"],"maxLength":120},"email":{"type":["string","null"],"maxLength":240},"phone":{"type":["string","null"],"maxLength":80},"defaultSupplierShippingInstructions":{"type":["string","null"],"maxLength":2000}},"additionalProperties":false}}}},"responses":{"200":{"description":"Updated supplier ship-from location, or dryRun returned write readiness.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["supplier_ship_from_location"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"apiPath":{"type":"string"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"archived":{"type":"boolean"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"externalId":{"type":["string","null"]},"name":{"type":"string"},"street1":{"type":["string","null"]},"street2":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"zip":{"type":["string","null"]},"country":{"type":["string","null"]},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"defaultSupplierShippingInstructions":{"type":["string","null"]},"requestedVia":{"type":"object","properties":{"type":{"type":"string","enum":["api_key"]},"id":{"type":"string","format":"uuid"},"purpose":{"type":["string","null"]}},"required":["type","id","purpose"],"additionalProperties":false},"idempotencyStatus":{"type":"string","enum":["created","replayed","updated","fetched"]}},"required":["type","id","displayName","apiPath","parent","archived","createdAt","updatedAt","externalId","name","street1","street2","city","state","zip","country","email","phone","defaultSupplierShippingInstructions","requestedVia","idempotencyStatus"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["write_readiness"]},"operation":{"type":"string","enum":["warehouses.create","warehouses.update","warehouses.archive","warehouses.unarchive","shipping_options.create","shipping_options.update","shipping_options.archive","shipping_options.unarchive","reorder_points.create","tags.create","tags.update","tag_assignments.create","tag_assignments.delete","notes.create","notes.update","opportunities.create","opportunities.update","opportunities.close","opportunities.meta-upsert","contacts.create","contacts.update","customers.create","customers.update","customer_locations.create","customer_locations.update","customer_addresses.create","customer_addresses.update","suppliers.create","suppliers.update","supplier_ship_from_locations.create","supplier_ship_from_locations.update","products.create","products.update","products.archive","products.unarchive","product_packaging.create","products.suppliers.create","products.suppliers.delete","products.aliases.create","products.aliases.update","products.aliases.delete","product_families.aliases.create","product_families.aliases.update","product_families.aliases.delete","products.customer_part_numbers.create","products.customer_part_numbers.update","products.customer_part_numbers.delete","product_sds.update","product_documents.create","customer_documents.create","supplier_documents.create","purchase_order_documents.create","product_families.create","product_families.update","cost_book_entries.create","current_cost_sources.put","customers.archive","customers.unarchive","suppliers.archive","suppliers.unarchive","contacts.archive","contacts.unarchive","customer_addresses.archive","customer_addresses.unarchive","supplier_ship_from_locations.archive","supplier_ship_from_locations.unarchive","representatives.create","representatives.update","representatives.archive","representatives.unarchive","payment_terms.create","payment_terms.update","ledger_accounts.create","ledger_accounts.update"]},"status":{"type":"string","enum":["ready","blocked"]},"wouldWrite":{"type":"boolean","enum":[false]},"submit":{"type":"object","properties":{"method":{"type":"string","enum":["POST","PATCH","PUT","DELETE"]},"path":{"type":"string"},"query":{"type":"object","properties":{},"additionalProperties":false}},"required":["method","path","query"],"additionalProperties":false},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false},"checks":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["not_direct_ship","address_role_required","address_role_valid","already_assigned","already_exists","active_duplicate","ambiguous_external_id","ambiguous_natural_key","api_created","archived_target","archived_record","archive_blocked","account_type_locked","duplicate_candidate_found","duplicate_candidate_overflow","duplicate_check_clear","duplicate_check_not_needed","duplicate_contact","duplicate_customer","duplicate_customer_address","duplicate_customer_location","duplicate_note","duplicate_resolution_applied","duplicate_supplier","duplicate_supplier_ship_from_location","document_url_org_scoped","document_url_valid","upload_verified","sds_converged","idempotency_available","idempotency_key_required","idempotency_key_reused","idempotency_replay","idempotency_target_missing","income_statement_type_invalid","hard_identity_clear","nested_external_id_clear","commercial_references_valid","credit_denomination_mismatch","customer_service_representative_reference_active","ledger_account_reference_valid","payment_terms_reference_exists","sales_person_reference_active","supplier_representative_reference_active","duplicate_reference_identity","external_id_conflict","if_match_current","base_uom_transition_allowed","base_uom_transition_blocked","attribute_assignments_valid","attribute_assignments_invalid","selected_supplier_link","linked_records_available","natural_key_conflict","not_api_created","no_downstream_mutation","order_sensitive_update_allowed","order_sensitive_update_blocked","parent_available","cost_book_entry_blocked","cost_book_entry_valid","cost_book_reference_not_visible","unsupported_cost_book_uom","cost_uom_conversion_unavailable","cost_book_base_unavailable","cost_book_base_ambiguous","cost_ship_from_location_not_visible","cost_package_quantity_invalid","cost_component_invalid","cost_date_window_invalid","cost_date_overlap","cost_amount_overflow","cost_book_conflict","product_family_reference_active","product_packaging_reference_active","primary_child_available","primary_change_unsupported","reference_visibility_blocked","scope_authorized","stale_record","stale_cost_book_entry","supplier_reference_active","tag_applicable","tag_available","tag_exists","tag_found","tag_not_applicable","tag_not_found","type_immutable","type_known","type_required","target_active","target_available","target_not_found_or_not_visible","targets_visible","unsupported_linked_record","unsupported_profile_shape","variable_qty_valid","validation_failed","value_nonempty"]},"status":{"type":"string","enum":["passed","blocked"]},"message":{"type":"string"},"param":{"type":"string"}},"required":["code","status","message"],"additionalProperties":false}},"duplicateCandidates":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact","customer","supplier","customer_location","customer_address","supplier_ship_from_location","product","product_family","document"]},"readable":{"type":"boolean"},"version":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","product","purchase_order"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"matchReasons":{"type":"array","items":{"type":"string","enum":["name","email","externalId","address","code","product","url"]}},"readbackPath":{"type":"string"}},"required":["type","readable","matchReasons"],"additionalProperties":false}},"idempotency":{"type":"object","properties":{"required":{"type":"boolean"},"keyProvided":{"type":"boolean"},"wouldReplay":{"type":"boolean"}},"required":["required","keyProvided","wouldReplay"],"additionalProperties":false},"wouldChange":{"type":"object","properties":{"fieldNames":{"type":"array","items":{"type":"string"}},"values":{"type":"object","additionalProperties":{}}},"required":["fieldNames","values"],"additionalProperties":false},"impactAnalysis":{"type":"object","additionalProperties":{}},"requestId":{"type":"string"}},"required":["type","operation","status","wouldWrite","submit","verification","checks","duplicateCandidates","requestId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}]}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested parent or record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"409":{"description":"The write conflicted with an existing record, idempotency payload, or stale If-Match value.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/orders":{"get":{"operationId":"findPublicAPIOrders","summary":"Find sales orders","description":"Bounded sales-order finder with exact identifiers, status, customer, product, linked-order, business-date, changed-record, and creator filters. orderNo, customerOrderNo, and externalId accept up to 25 comma-separated exact tokens; for example, GET /api/v1/orders?customerOrderNo=A,B,C&limit=5. Send finder inputs as query parameters. After the first page, continue with only the exact returned meta.nextCursor value in cursor; do not repeat filters or limit. Changed traversal keeps one fixed snapshot.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"orders:read","parameters":[{"schema":{"type":"string","format":"uuid"},"required":false,"name":"createdById","in":"query"},{"schema":{"type":"string","format":"date-time","description":"Inclusive creation timestamp; pair with createdTo; maximum 366 days."},"required":false,"description":"Inclusive creation timestamp; pair with createdTo; maximum 366 days.","name":"createdFrom","in":"query"},{"schema":{"type":"string","format":"date-time","description":"Exclusive creation timestamp; pair with createdFrom; maximum 366 days."},"required":false,"description":"Exclusive creation timestamp; pair with createdFrom; maximum 366 days.","name":"createdTo","in":"query"},{"schema":{"type":"string","description":"One exact order number or up to 25 comma-separated exact order numbers."},"required":false,"description":"One exact order number or up to 25 comma-separated exact order numbers.","name":"orderNo","in":"query"},{"schema":{"type":"string","description":"One exact customer order number or up to 25 comma-separated exact customer order numbers."},"required":false,"description":"One exact customer order number or up to 25 comma-separated exact customer order numbers.","name":"customerOrderNo","in":"query"},{"schema":{"type":"string","description":"One exact external id or up to 25 comma-separated exact external ids."},"required":false,"description":"One exact external id or up to 25 comma-separated exact external ids.","name":"externalId","in":"query"},{"schema":{"type":"string","format":"uuid"},"required":false,"name":"customerId","in":"query"},{"schema":{"type":"string","format":"uuid"},"required":false,"name":"productId","in":"query"},{"schema":{"type":"string","format":"uuid"},"required":false,"name":"productFamilyId","in":"query"},{"schema":{"type":"string","format":"uuid"},"required":false,"name":"linkedPurchaseOrderId","in":"query"},{"schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Start of the ordered-date window (inclusive), as YYYY-MM-DD in your organization's time zone. Send it with toDate."},"required":false,"description":"Start of the ordered-date window (inclusive), as YYYY-MM-DD in your organization's time zone. Send it with toDate.","name":"fromDate","in":"query"},{"schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"End of the ordered-date window (inclusive), as YYYY-MM-DD in your organization's time zone. Send it with fromDate."},"required":false,"description":"End of the ordered-date window (inclusive), as YYYY-MM-DD in your organization's time zone. Send it with fromDate.","name":"toDate","in":"query"},{"schema":{"type":"string","format":"date-time","description":"Start of the last-updated sync window (inclusive). Send it with changedTo to pick up orders changed since your last sync."},"required":false,"description":"Start of the last-updated sync window (inclusive). Send it with changedTo to pick up orders changed since your last sync.","name":"changedFrom","in":"query"},{"schema":{"type":"string","format":"date-time","description":"End of the last-updated sync window (exclusive). Send it with changedFrom, and keep the window to 30 days or fewer."},"required":false,"description":"End of the last-updated sync window (exclusive). Send it with changedFrom, and keep the window to 30 days or fewer.","name":"changedTo","in":"query"},{"schema":{"type":"string","enum":["DRAFT","CONFIRMED","SHIPPED","DELIVERED","COMPLETED","VOID"]},"required":false,"name":"status","in":"query"},{"schema":{"type":"string"},"required":false,"name":"limit","in":"query"},{"schema":{"type":"string"},"required":false,"name":"cursor","in":"query"}],"responses":{"200":{"description":"Sales-order finder summaries.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time"},"createdBy":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["user"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["system"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string","enum":["System User"]}},"required":["type","id","displayName"],"additionalProperties":false}]},"object":{"type":"string","enum":["sales_order"]},"id":{"type":"string","format":"uuid"},"orderNo":{"type":"string"},"customerOrderNo":{"type":["string","null"]},"externalId":{"type":["string","null"]},"customer":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"externalId":{"type":["string","null"]},"url":{"type":"string"}},"required":["id","displayName","externalId","url"],"additionalProperties":false},"status":{"type":"string"},"orderType":{"type":"string"},"orderedAt":{"type":["string","null"],"format":"date-time"},"shipBy":{"type":["string","null"],"format":"date-time"},"requiredBy":{"type":["string","null"],"format":"date-time"},"shippedAt":{"type":["string","null"],"format":"date-time"},"deliveredAt":{"type":["string","null"],"format":"date-time"},"linkedPurchaseOrder":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"orderNo":{"type":"string"},"url":{"type":"string"}},"required":["id","orderNo","url"],"additionalProperties":false},"totals":{"type":"object","properties":{"totalAmountCents":{"type":"string"},"currency":{"type":"string","minLength":3,"maxLength":3}},"required":["totalAmountCents","currency"],"additionalProperties":false},"productIds":{"type":"array","items":{"type":"string","format":"uuid"}},"url":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"}},"required":["createdAt","createdBy","object","id","orderNo","customerOrderNo","externalId","customer","status","orderType","orderedAt","shipBy","requiredBy","shippedAt","deliveredAt","linkedPurchaseOrder","totals","productIds","url","updatedAt"],"additionalProperties":false}},"meta":{"type":"object","properties":{"requestId":{"type":"string"},"mode":{"type":"string","enum":["finder"]},"limit":{"type":"integer","exclusiveMinimum":0,"maximum":25},"returnedRows":{"type":"integer","minimum":0},"hasMore":{"type":"boolean"},"nextCursor":{"type":["string","null"]},"ordering":{"type":"string","enum":["business_date_desc_id_desc","updated_at_desc_id_desc"]},"snapshotAt":{"type":"string","format":"date-time"},"synchronizationGuidance":{"type":"string"}},"required":["requestId","mode","limit","returnedRows","hasMore","nextCursor","ordering","snapshotAt"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Sales-order finder validation failed.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false},"examples":{"cursor-query-conflict":{"summary":"An order cursor was combined with another query parameter","value":{"error":{"type":"validation_error","code":"cursor_query_conflict","message":"An order cursor must be supplied without any other query parameter.","param":"cursor","doNotRetrySameRequest":true,"suggestedAction":"stop_and_fix_request","documentationPath":"/api/v1/openapi.json","requestId":"req-example"}}},"invalid-order-cursor":{"summary":"The order cursor does not match the actor or route","value":{"error":{"type":"validation_error","code":"invalid_order_cursor","message":"The order cursor is invalid or does not match this API actor and route.","param":"cursor","doNotRetrySameRequest":true,"suggestedAction":"stop_and_fix_request","documentationPath":"/api/v1/openapi.json","requestId":"req-example"}}},"invalid-limit":{"summary":"The sales-order finder limit is outside the supported range","value":{"error":{"type":"validation_error","code":"validation_failed","message":"Request validation failed.","param":"limit","errors":[{"path":"limit","message":"Number must be less than or equal to 25"}],"narrowingHints":["Use a numeric limit from 1 through 25."],"doNotRetrySameRequest":true,"acceptedFilters":["orderNo","customerOrderNo","externalId","customerId","productId","productFamilyId","linkedPurchaseOrderId","fromDate+toDate","changedFrom+changedTo","status","limit","cursor"],"example":{"orderNo":"SO-1001","limit":10},"suggestedAction":"choose_valid_value","documentationPath":"/api/v1/openapi.json","repairCategory":"invalid_limit","requestId":"req-example"}}}}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/orders/{id}":{"get":{"operationId":"getPublicAPISalesOrderDocument","summary":"Get sales-order detail","description":"Returns the read-only sales-order header, stable line page, explicit fulfillment evidence, and exact stored totals with resolved document currency. No mutation, inventory write, or cost cascade occurs.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"orders:read","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","pattern":"^\\d+$","description":"Line page size. Defaults to 100 and has a maximum of 500."},"required":false,"description":"Line page size. Defaults to 100 and has a maximum of 500.","name":"lineLimit","in":"query"},{"schema":{"type":"string","description":"Signed line continuation. When present, send lineCursor alone."},"required":false,"description":"Signed line continuation. When present, send lineCursor alone.","name":"lineCursor","in":"query"}],"responses":{"200":{"description":"Sales-order detail.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"object":{"type":"string","enum":["sales_order"]},"id":{"type":"string","format":"uuid"},"url":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"},"header":{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time"},"createdBy":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["user"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["system"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string","enum":["System User"]}},"required":["type","id","displayName"],"additionalProperties":false}]},"orderNo":{"type":"string"},"externalId":{"type":["string","null"]},"type":{"type":"string"},"status":{"type":"string"},"customer":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"externalId":{"type":["string","null"]},"url":{"type":"string"}},"required":["id","displayName","externalId","url"],"additionalProperties":false},"linkedPurchaseOrder":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"orderNo":{"type":"string"},"url":{"type":"string"}},"required":["id","orderNo","url"],"additionalProperties":false},"shipTo":{"type":["object","null"],"properties":{"id":{"type":["string","null"],"format":"uuid"},"name":{"type":["string","null"]},"street1":{"type":["string","null"]},"street2":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"zip":{"type":["string","null"]},"country":{"type":["string","null"]}},"required":["id","name","street1","street2","city","state","zip","country"],"additionalProperties":false},"shippingInstructions":{"type":"string"},"customerOrderNo":{"type":["string","null"]},"orderedAt":{"type":["string","null"]},"shipBy":{"type":["string","null"]},"requiredBy":{"type":["string","null"]},"shippedAt":{"type":["string","null"]},"deliveredAt":{"type":["string","null"]},"assignedTo":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["id","displayName"],"additionalProperties":false},"warehouse":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["id","displayName"],"additionalProperties":false},"freightTerms":{"type":["string","null"]},"freightMethod":{"type":["string","null"]}},"required":["createdAt","createdBy","orderNo","externalId","type","status","customer","linkedPurchaseOrder","shipTo","shippingInstructions","customerOrderNo","orderedAt","shipBy","requiredBy","shippedAt","deliveredAt","assignedTo","warehouse","freightTerms","freightMethod"],"additionalProperties":false},"lineItems":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"lineType":{"type":"string","enum":["product","non_product"]},"description":{"type":"string"},"product":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"code":{"type":"string"},"displayName":{"type":"string"},"productFamily":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false}},"required":["id","code","displayName","productFamily"],"additionalProperties":false},"quantity":{"type":"string"},"productQuantity":{"type":["string","null"]},"uom":{"type":["string","null"]},"unitPriceCents":{"type":["string","null"]},"extendedAmountCents":{"type":"string"},"currency":{"type":"string","pattern":"^[A-Z]{3}$"},"fulfillment":{"type":"object","properties":{"consumedAt":{"type":["string","null"]},"allocated":{"type":"boolean"},"virtualInventory":{"type":"boolean"}},"required":["consumedAt","allocated","virtualInventory"],"additionalProperties":false}},"required":["id","lineType","description","product","quantity","productQuantity","uom","unitPriceCents","extendedAmountCents","currency","fulfillment"],"additionalProperties":false}},"totals":{"type":"object","properties":{"subtotalAmountCents":{"type":"string"},"taxAmountCents":{"type":"string"},"shippingAmountCents":{"type":"string"},"feeAmountCents":{"type":"string"},"totalAmountCents":{"type":"string"},"currency":{"type":"string","minLength":3,"maxLength":3}},"required":["subtotalAmountCents","taxAmountCents","shippingAmountCents","feeAmountCents","totalAmountCents","currency"],"additionalProperties":false},"lineCoverage":{"type":"object","properties":{"totalLines":{"type":"integer","minimum":0},"returnedLines":{"type":"integer","minimum":0},"hasMore":{"type":"boolean"},"nextLineCursor":{"type":["string","null"]}},"required":["totalLines","returnedLines","hasMore","nextLineCursor"],"additionalProperties":false}},"required":["object","id","url","updatedAt","header","lineItems","totals","lineCoverage"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/purchase-orders":{"get":{"operationId":"findPublicAPIPurchaseOrders","summary":"Find purchase orders","description":"Bounded purchase-order finder with exact identifiers, status, supplier, product, linked-order, business-date, changed-record, and creator filters. orderNo and externalId accept up to 25 comma-separated exact tokens. Send finder inputs as query parameters. After the first page, continue with only the exact returned meta.nextCursor value in cursor; do not repeat filters or limit. Changed traversal keeps one fixed snapshot.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"purchase-orders:read","parameters":[{"schema":{"type":"string","format":"uuid"},"required":false,"name":"createdById","in":"query"},{"schema":{"type":"string","format":"date-time","description":"Inclusive creation timestamp; pair with createdTo; maximum 366 days."},"required":false,"description":"Inclusive creation timestamp; pair with createdTo; maximum 366 days.","name":"createdFrom","in":"query"},{"schema":{"type":"string","format":"date-time","description":"Exclusive creation timestamp; pair with createdFrom; maximum 366 days."},"required":false,"description":"Exclusive creation timestamp; pair with createdFrom; maximum 366 days.","name":"createdTo","in":"query"},{"schema":{"type":"string","description":"One exact order number or up to 25 comma-separated exact order numbers."},"required":false,"description":"One exact order number or up to 25 comma-separated exact order numbers.","name":"orderNo","in":"query"},{"schema":{"type":"string","description":"One exact external id or up to 25 comma-separated exact external ids."},"required":false,"description":"One exact external id or up to 25 comma-separated exact external ids.","name":"externalId","in":"query"},{"schema":{"type":"string","format":"uuid"},"required":false,"name":"supplierId","in":"query"},{"schema":{"type":"string","format":"uuid"},"required":false,"name":"productId","in":"query"},{"schema":{"type":"string","format":"uuid"},"required":false,"name":"productFamilyId","in":"query"},{"schema":{"type":"string","format":"uuid"},"required":false,"name":"linkedSalesOrderId","in":"query"},{"schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Start of the due-date window (inclusive), as YYYY-MM-DD in your organization's time zone. Send it with toDate."},"required":false,"description":"Start of the due-date window (inclusive), as YYYY-MM-DD in your organization's time zone. Send it with toDate.","name":"fromDate","in":"query"},{"schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"End of the due-date window (inclusive), as YYYY-MM-DD in your organization's time zone. Send it with fromDate."},"required":false,"description":"End of the due-date window (inclusive), as YYYY-MM-DD in your organization's time zone. Send it with fromDate.","name":"toDate","in":"query"},{"schema":{"type":"string","format":"date-time","description":"Start of the last-updated sync window (inclusive). Pair with changedTo to pick up purchase orders changed since your last sync."},"required":false,"description":"Start of the last-updated sync window (inclusive). Pair with changedTo to pick up purchase orders changed since your last sync.","name":"changedFrom","in":"query"},{"schema":{"type":"string","format":"date-time","description":"End of the last-updated sync window (exclusive). Send it with changedFrom, and keep the window to 30 days or fewer."},"required":false,"description":"End of the last-updated sync window (exclusive). Send it with changedFrom, and keep the window to 30 days or fewer.","name":"changedTo","in":"query"},{"schema":{"type":"string","enum":["DRAFT","CONFIRMED","COMPLETED","VOID"]},"required":false,"name":"status","in":"query"},{"schema":{"type":"string"},"required":false,"name":"limit","in":"query"},{"schema":{"type":"string"},"required":false,"name":"cursor","in":"query"}],"responses":{"200":{"description":"Purchase-order finder summaries.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time"},"createdBy":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["user"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["system"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string","enum":["System User"]}},"required":["type","id","displayName"],"additionalProperties":false}]},"object":{"type":"string","enum":["purchase_order"]},"id":{"type":"string","format":"uuid"},"orderNo":{"type":"string"},"externalId":{"type":["string","null"]},"supplier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"externalId":{"type":["string","null"]},"url":{"type":"string"}},"required":["id","displayName","externalId","url"],"additionalProperties":false},"linkedSalesOrder":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"orderNo":{"type":"string"},"customerOrderNo":{"type":["string","null"]},"url":{"type":"string"}},"required":["id","orderNo","customerOrderNo","url"],"additionalProperties":false},"status":{"type":"string"},"orderType":{"type":"string"},"submittedAt":{"type":["string","null"],"format":"date-time"},"dueAt":{"type":["string","null"],"format":"date-time"},"fullyReceivedAt":{"type":["string","null"],"format":"date-time"},"totals":{"type":"object","properties":{"totalAmountCents":{"type":"string"},"currency":{"type":"string","minLength":3,"maxLength":3}},"required":["totalAmountCents","currency"],"additionalProperties":false},"productIds":{"type":"array","items":{"type":"string","format":"uuid"}},"url":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"}},"required":["createdAt","createdBy","object","id","orderNo","externalId","supplier","linkedSalesOrder","status","orderType","submittedAt","dueAt","fullyReceivedAt","totals","productIds","url","updatedAt"],"additionalProperties":false}},"meta":{"type":"object","properties":{"requestId":{"type":"string"},"mode":{"type":"string","enum":["finder"]},"limit":{"type":"integer","exclusiveMinimum":0,"maximum":25},"returnedRows":{"type":"integer","minimum":0},"hasMore":{"type":"boolean"},"nextCursor":{"type":["string","null"]},"ordering":{"type":"string","enum":["business_date_desc_id_desc","updated_at_desc_id_desc"]},"snapshotAt":{"type":"string","format":"date-time"},"synchronizationGuidance":{"type":"string"}},"required":["requestId","mode","limit","returnedRows","hasMore","nextCursor","ordering","snapshotAt"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Purchase-order finder validation failed.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false},"examples":{"cursor-query-conflict":{"summary":"A purchase-order cursor was combined with another query parameter","value":{"error":{"type":"validation_error","code":"cursor_query_conflict","message":"An order cursor must be supplied without any other query parameter.","param":"cursor","doNotRetrySameRequest":true,"suggestedAction":"stop_and_fix_request","documentationPath":"/api/v1/openapi.json","requestId":"req-example"}}},"invalid-order-cursor":{"summary":"The purchase-order cursor does not match the actor or route","value":{"error":{"type":"validation_error","code":"invalid_order_cursor","message":"The order cursor is invalid or does not match this API actor and route.","param":"cursor","doNotRetrySameRequest":true,"suggestedAction":"stop_and_fix_request","documentationPath":"/api/v1/openapi.json","requestId":"req-example"}}},"invalid-limit":{"summary":"The purchase-order finder limit is outside the supported range","value":{"error":{"type":"validation_error","code":"validation_failed","message":"Request validation failed.","param":"limit","errors":[{"path":"limit","message":"Number must be less than or equal to 25"}],"narrowingHints":["Use a numeric limit from 1 through 25."],"doNotRetrySameRequest":true,"acceptedFilters":["orderNo","externalId","supplierId","productId","productFamilyId","linkedSalesOrderId","fromDate+toDate","changedFrom+changedTo","status","limit","cursor"],"example":{"orderNo":"PO-1001","limit":10},"suggestedAction":"choose_valid_value","documentationPath":"/api/v1/openapi.json","repairCategory":"invalid_limit","requestId":"req-example"}}}}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/purchase-orders/{id}":{"get":{"operationId":"getPublicAPIPurchaseOrderDocument","summary":"Get purchase-order detail","description":"Returns the read-only purchase-order header, stable line page, explicit receipt evidence, exact stored totals, and classified supplier document costs. No receiving, AP, GL, or mutation occurs.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"purchase-orders:read","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","pattern":"^\\d+$","description":"Line page size. Defaults to 100 and has a maximum of 500."},"required":false,"description":"Line page size. Defaults to 100 and has a maximum of 500.","name":"lineLimit","in":"query"},{"schema":{"type":"string","description":"Signed line continuation. When present, send lineCursor alone."},"required":false,"description":"Signed line continuation. When present, send lineCursor alone.","name":"lineCursor","in":"query"}],"responses":{"200":{"description":"Purchase-order detail.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"object":{"type":"string","enum":["purchase_order"]},"id":{"type":"string","format":"uuid"},"url":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"},"header":{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time"},"createdBy":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["user"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["system"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string","enum":["System User"]}},"required":["type","id","displayName"],"additionalProperties":false}]},"orderNo":{"type":"string"},"externalId":{"type":["string","null"]},"type":{"type":"string"},"status":{"type":"string"},"supplier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"externalId":{"type":["string","null"]},"url":{"type":"string"}},"required":["id","displayName","externalId","url"],"additionalProperties":false},"supplierInstructions":{"type":["string","null"]},"linkedSalesOrder":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"orderNo":{"type":"string"},"customerOrderNo":{"type":["string","null"]},"url":{"type":"string"}},"required":["id","orderNo","customerOrderNo","url"],"additionalProperties":false},"shipFrom":{"type":["object","null"],"properties":{"id":{"type":["string","null"],"format":"uuid"},"name":{"type":["string","null"]},"street1":{"type":["string","null"]},"street2":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"zip":{"type":["string","null"]},"country":{"type":["string","null"]}},"required":["id","name","street1","street2","city","state","zip","country"],"additionalProperties":false},"assignedTo":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["id","displayName"],"additionalProperties":false},"warehouse":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["id","displayName"],"additionalProperties":false},"submittedAt":{"type":["string","null"]},"confirmedAt":{"type":["string","null"]},"completedAt":{"type":["string","null"]},"fullyReceivedAt":{"type":["string","null"]},"shipAt":{"type":["string","null"]},"dueAt":{"type":["string","null"]},"freightTerms":{"type":["string","null"]},"shipVia":{"type":["string","null"]}},"required":["createdAt","createdBy","orderNo","externalId","type","status","supplier","supplierInstructions","linkedSalesOrder","shipFrom","assignedTo","warehouse","submittedAt","confirmedAt","completedAt","fullyReceivedAt","shipAt","dueAt","freightTerms","shipVia"],"additionalProperties":false},"lineItems":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"description":{"type":"string"},"product":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"code":{"type":"string"},"displayName":{"type":"string"},"productFamily":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false}},"required":["id","code","displayName","productFamily"],"additionalProperties":false},"quantity":{"type":"string"},"productQuantity":{"type":"string"},"uom":{"type":"string"},"unitCostCents":{"type":["string","null"]},"extendedAmountCents":{"type":"string"},"currency":{"type":"string","pattern":"^[A-Z]{3}$"},"receipt":{"type":"object","properties":{"receiptCount":{"type":"integer","minimum":0},"firstReceivedAt":{"type":["string","null"]},"lastReceivedAt":{"type":["string","null"]},"virtualInventory":{"type":"boolean"}},"required":["receiptCount","firstReceivedAt","lastReceivedAt","virtualInventory"],"additionalProperties":false}},"required":["id","description","product","quantity","productQuantity","uom","unitCostCents","extendedAmountCents","currency","receipt"],"additionalProperties":false}},"costs":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"description":{"type":"string"},"amountCents":{"type":"string"},"currency":{"type":"string","pattern":"^[A-Z]{3}$"},"linkedLineId":{"type":["string","null"],"format":"uuid"}},"required":["id","description","amountCents","currency","linkedLineId"],"additionalProperties":false}},"totals":{"type":"object","properties":{"itemsAmountCents":{"type":"string"},"costsAmountCents":{"type":"string","description":"The document's non-item total component. It uses stored standalone PO costs for ordinary documents and, when row-level comparable evidence is required, includes margin-participating PO cost contributors plus margin-participating linked sales-order costs billed by the PO supplier. itemsAmountCents + costsAmountCents equals totalAmountCents. This field does not reconcile against the costs array, which lists this supplier's own costs on a different basis."},"totalAmountCents":{"type":"string"},"currency":{"type":"string","minLength":3,"maxLength":3}},"required":["itemsAmountCents","costsAmountCents","totalAmountCents","currency"],"additionalProperties":false},"lineCoverage":{"type":"object","properties":{"totalLines":{"type":"integer","minimum":0},"returnedLines":{"type":"integer","minimum":0},"hasMore":{"type":"boolean"},"nextLineCursor":{"type":["string","null"]}},"required":["totalLines","returnedLines","hasMore","nextLineCursor"],"additionalProperties":false}},"required":["object","id","url","updatedAt","header","lineItems","costs","totals","lineCoverage"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/purchase-order-execution":{"get":{"operationId":"findPublicAPIPurchaseExecution","summary":"Find purchase execution","description":"Returns current open purchase-order lines with deterministic receipt-progress classification and explicit quantity evidence. warehouseId filters the purchase-order header warehouse; null headers do not match, while every row returns nullable warehouse identity. executionChangedAt is the newest included Purchase Order, line, or receipt audit timestamp and is a conservative refetch hint: it may advance for non-projected row changes and does not cover documents, referenced labels, or deleted-receipt discovery. Send finder inputs as query parameters. After the first page, continue with only the exact returned meta.nextCursor value in cursor; do not repeat filters or limit. Each page reflects current data when requested.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"purchase-order-execution:read","parameters":[{"schema":{"type":"string","format":"uuid"},"required":false,"name":"supplierId","in":"query"},{"schema":{"type":"string","format":"uuid"},"required":false,"name":"productId","in":"query"},{"schema":{"type":"string","format":"uuid"},"required":false,"name":"productFamilyId","in":"query"},{"schema":{"type":"string","format":"uuid","description":"Exact purchase-order header warehouse; null headers do not match."},"required":false,"description":"Exact purchase-order header warehouse; null headers do not match.","name":"warehouseId","in":"query"},{"schema":{"type":"string","enum":["true","false"]},"required":false,"name":"includeDraft","in":"query"},{"schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"required":false,"name":"dueFrom","in":"query"},{"schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"required":false,"name":"dueTo","in":"query"},{"schema":{"type":"string","pattern":"^\\d+$"},"required":false,"name":"limit","in":"query"},{"schema":{"type":"string"},"required":false,"name":"cursor","in":"query"}],"responses":{"200":{"description":"Current purchase-order execution lines.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["purchase_order_execution_line"]},"id":{"type":"string","format":"uuid"},"purchaseOrder":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"orderNo":{"type":"string"},"externalId":{"type":["string","null"]},"status":{"type":"string","enum":["DRAFT","CONFIRMED"]},"type":{"type":"string","enum":["STOCK_ORDER","DIRECT_SHIP","BLIND_SHIP"]},"dueAt":{"type":["string","null"],"format":"date-time"},"url":{"type":"string"}},"required":["id","orderNo","externalId","status","type","dueAt","url"],"additionalProperties":false},"supplier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"externalId":{"type":["string","null"]},"url":{"type":"string"}},"required":["id","displayName","externalId","url"],"additionalProperties":false},"warehouse":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false},"product":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"code":{"type":"string"},"productFamily":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false},"url":{"type":"string"}},"required":["id","code","productFamily","url"],"additionalProperties":false},"packaging":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"type":{"type":"string","enum":["FIXED","VARIABLE"]},"uom":{"type":"string"},"capacityUOM":{"type":"string","pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d*[1-9])?$"}},"required":["id","name","type","uom","capacityUOM"],"additionalProperties":false},"receiptState":{"type":"string","enum":["no_receipt_evidence","planned_not_received","quantity_basis_unknown","partially_received","received_to_expected","over_received"]},"evidenceQuality":{"type":"string","enum":["authoritative","legacy_inferred","unknown"]},"expectedQuantity":{"type":["object","null"],"properties":{"value":{"type":"string","pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d*[1-9])?$"},"basis":{"type":"string","enum":["packages","base_units"]},"uom":{"type":"string"},"productPackagingId":{"type":"string","format":"uuid"},"capacityUOM":{"type":["string","null"],"pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d*[1-9])?$"}},"required":["value","basis","uom","productPackagingId","capacityUOM"],"additionalProperties":false},"receivedQuantity":{"type":["object","null"],"properties":{"value":{"type":"string","pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d*[1-9])?$"},"basis":{"type":"string","enum":["packages","base_units"]},"uom":{"type":"string"},"productPackagingId":{"type":"string","format":"uuid"},"capacityUOM":{"type":["string","null"],"pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d*[1-9])?$"}},"required":["value","basis","uom","productPackagingId","capacityUOM"],"additionalProperties":false},"remainingQuantity":{"type":["object","null"],"properties":{"value":{"type":"string","pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d*[1-9])?$"},"basis":{"type":"string","enum":["packages","base_units"]},"uom":{"type":"string"},"productPackagingId":{"type":"string","format":"uuid"},"capacityUOM":{"type":["string","null"],"pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d*[1-9])?$"}},"required":["value","basis","uom","productPackagingId","capacityUOM"],"additionalProperties":false},"overReceivedQuantity":{"type":["object","null"],"properties":{"value":{"type":"string","pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d*[1-9])?$"},"basis":{"type":"string","enum":["packages","base_units"]},"uom":{"type":"string"},"productPackagingId":{"type":"string","format":"uuid"},"capacityUOM":{"type":["string","null"],"pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d*[1-9])?$"}},"required":["value","basis","uom","productPackagingId","capacityUOM"],"additionalProperties":false},"receiptEventCount":{"type":"integer","minimum":0},"firstReceivedAt":{"type":["string","null"],"format":"date-time"},"lastReceivedAt":{"type":["string","null"],"format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"executionChangedAt":{"type":"string","format":"date-time","description":"Newest included Purchase Order, line, or receipt updatedAt. Conservative refetch hint, not a lossless change feed."},"receiptEventsUrl":{"type":"string"},"documentsUrl":{"type":"string","description":"Authorized purchase-order document navigation URL."}},"required":["type","id","purchaseOrder","supplier","warehouse","product","packaging","receiptState","evidenceQuality","expectedQuantity","receivedQuantity","remainingQuantity","overReceivedQuantity","receiptEventCount","firstReceivedAt","lastReceivedAt","updatedAt","executionChangedAt","receiptEventsUrl","documentsUrl"],"additionalProperties":false}},"meta":{"type":"object","properties":{"returnedRows":{"type":"integer","minimum":0},"hasMore":{"type":"boolean"},"nextCursor":{"type":["string","null"]},"ordering":{"type":"string","enum":["due_at_asc_purchase_order_id_asc_line_id_asc"]},"observedAt":{"type":"string","format":"date-time"},"currentState":{"type":"boolean","enum":[true]},"snapshotIsolatedAcrossRequests":{"type":"boolean","enum":[false]},"requestId":{"type":"string"}},"required":["returnedRows","hasMore","nextCursor","ordering","observedAt","currentState","snapshotIsolatedAcrossRequests","requestId"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false},"examples":{"receipt-aware-current-state":{"summary":"Current purchase execution with operational freshness and navigation","value":{"data":[{"type":"purchase_order_execution_line","id":"11111111-1111-4111-8111-111111111111","purchaseOrder":{"id":"22222222-2222-4222-8222-222222222222","orderNo":"PO-100","externalId":null,"status":"CONFIRMED","type":"STOCK_ORDER","dueAt":"2026-08-20T12:00:00.000Z","url":"https://app.shelfcycle.com/acme/purchase-orders/22222222-2222-4222-8222-222222222222"},"supplier":{"id":"33333333-3333-4333-8333-333333333333","displayName":"Primary Chemical Supply","externalId":null,"url":"https://app.shelfcycle.com/acme/suppliers/33333333-3333-4333-8333-333333333333"},"warehouse":{"id":"77777777-7777-4777-8777-777777777777","name":"Main Warehouse"},"product":{"id":"44444444-4444-4444-8444-444444444444","code":"CHEM-1","productFamily":{"id":"55555555-5555-4555-8555-555555555555","name":"Acetone"},"url":"https://app.shelfcycle.com/acme/products/44444444-4444-4444-8444-444444444444"},"packaging":{"id":"66666666-6666-4666-8666-666666666666","name":"Drum","type":"FIXED","uom":"GALLON","capacityUOM":"55"},"receiptState":"partially_received","evidenceQuality":"authoritative","expectedQuantity":{"value":"10","basis":"packages","uom":"GALLON","productPackagingId":"66666666-6666-4666-8666-666666666666","capacityUOM":"55"},"receivedQuantity":{"value":"4","basis":"packages","uom":"GALLON","productPackagingId":"66666666-6666-4666-8666-666666666666","capacityUOM":"55"},"remainingQuantity":{"value":"6","basis":"packages","uom":"GALLON","productPackagingId":"66666666-6666-4666-8666-666666666666","capacityUOM":"55"},"overReceivedQuantity":null,"receiptEventCount":1,"firstReceivedAt":"2026-08-10T12:00:00.000Z","lastReceivedAt":"2026-08-10T12:00:00.000Z","updatedAt":"2026-08-09T12:00:00.000Z","executionChangedAt":"2026-08-10T13:00:00.000Z","receiptEventsUrl":"https://app.shelfcycle.com/acme/purchase-order-lines/11111111-1111-4111-8111-111111111111/receipt-events","documentsUrl":"https://app.shelfcycle.com/acme/purchase-orders/22222222-2222-4222-8222-222222222222/documents"}],"meta":{"returnedRows":1,"hasMore":false,"nextCursor":null,"ordering":"due_at_asc_purchase_order_id_asc_line_id_asc","observedAt":"2026-08-11T12:00:00.000Z","currentState":true,"snapshotIsolatedAcrossRequests":false,"requestId":"req-purchase-execution"}}}}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Purchase-execution finder validation failed.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false},"examples":{"invalid-cursor":{"summary":"A cursor was combined with a purchase-execution filter","value":{"error":{"type":"validation_error","code":"invalid_cursor","message":"Cursor is invalid for this API key or purchase execution filter set.","param":"cursor","retryable":false,"doNotRetrySameRequest":true,"requestId":"req-example"}}},"invalid-limit":{"summary":"The purchase-execution limit is outside the supported range","value":{"error":{"type":"validation_error","code":"validation_failed","message":"Request validation failed.","param":"limit","errors":[{"path":"limit","message":"Number must be less than or equal to 100"}],"narrowingHints":["Use a numeric limit from 1 through 100."],"doNotRetrySameRequest":true,"acceptedFilters":["supplierId","productId","productFamilyId","warehouseId","includeDraft","dueFrom","dueTo","limit","cursor"],"example":{"limit":25},"suggestedAction":"choose_valid_value","documentationPath":"/api/v1/openapi.json","repairCategory":"invalid_limit","requestId":"req-example"}}}}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/purchase-order-lines/{id}/receipt-events":{"get":{"operationId":"getPublicAPIPurchaseReceiptEvents","summary":"Get purchase receipt events","description":"Returns stable raw receipt-event evidence for one authorized purchase-order line, including planned rows and explicit basis quality.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"purchase-order-execution:read","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","pattern":"^\\d+$"},"required":false,"name":"limit","in":"query"},{"schema":{"type":"string"},"required":false,"name":"cursor","in":"query"}],"responses":{"200":{"description":"Purchase receipt events.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["purchase_receipt_event"]},"id":{"type":"string","format":"uuid"},"lotNumber":{"type":["string","null"]},"lotNumberEvidence":{"type":"string","enum":["assigned","not_assigned"]},"quantity":{"type":"string","pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d*[1-9])?$"},"receivedAt":{"type":["string","null"],"format":"date-time"},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["user"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["system"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string","enum":["System User"]}},"required":["type","id","displayName"],"additionalProperties":false}]},"updatedAt":{"type":"string","format":"date-time"},"productPackagingId":{"type":["string","null"],"format":"uuid"},"capacityUOM":{"type":["string","null"],"pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d*[1-9])?$"},"basisEvidence":{"type":"string","enum":["fixed_snapshot","fixed_catalog_fallback","variable_snapshot","variable_snapshot_missing","packaging_incompatible"]},"evidenceQuality":{"type":"string","enum":["authoritative","legacy_inferred","unknown"]}},"required":["type","id","lotNumber","lotNumberEvidence","quantity","receivedAt","createdAt","createdBy","updatedAt","productPackagingId","capacityUOM","basisEvidence","evidenceQuality"],"additionalProperties":false}},"meta":{"type":"object","properties":{"purchaseOrderItemId":{"type":"string","format":"uuid"},"purchaseOrderId":{"type":"string","format":"uuid"},"returnedRows":{"type":"integer","minimum":0},"hasMore":{"type":"boolean"},"nextCursor":{"type":["string","null"]},"ordering":{"type":"string","enum":["created_at_asc_id_asc"]},"observedAt":{"type":"string","format":"date-time"},"requestId":{"type":"string"}},"required":["purchaseOrderItemId","purchaseOrderId","returnedRows","hasMore","nextCursor","ordering","observedAt","requestId"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/inventory-balances":{"get":{"operationId":"findPublicAPIInventoryBalances","summary":"Find inventory balances","description":"Returns current physical inventory balances and complete stock-out counts across products and warehouses before availability filtering. Continue with the signed cursor alone. Each page reflects current data when requested.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"inventory:read","parameters":[{"schema":{"type":"string","format":"uuid"},"required":false,"name":"productId","in":"query"},{"schema":{"type":"string","format":"uuid"},"required":false,"name":"productFamilyId","in":"query"},{"schema":{"type":"string","format":"uuid"},"required":false,"name":"warehouseId","in":"query"},{"schema":{"type":"string","enum":["zero_on_hand","fully_allocated","positive_available"]},"required":false,"name":"availabilityState","in":"query"},{"schema":{"type":"string","pattern":"^\\d+$"},"required":false,"name":"limit","in":"query"},{"schema":{"type":"string"},"required":false,"name":"cursor","in":"query"}],"responses":{"200":{"description":"Current physical inventory balances.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["inventory_balance"]},"product":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"code":{"type":"string"},"archived":{"type":"boolean"},"family":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false}},"required":["id","code","archived","family"],"additionalProperties":false},"warehouse":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"archived":{"type":"boolean"}},"required":["id","name","archived"],"additionalProperties":false},"basis":{"type":"object","properties":{"type":{"type":"string","enum":["package_count","base_uom"]},"unitOfMeasure":{"type":"string"},"packaging":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false}},"required":["type","unitOfMeasure","packaging"],"additionalProperties":false},"onHand":{"type":"string","pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d*[1-9])?$"},"allocated":{"type":"string","pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d*[1-9])?$"},"available":{"type":"string","pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d*[1-9])?$"},"quarantinedOnHand":{"type":"string","pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d*[1-9])?$"}},"required":["type","product","warehouse","basis","onHand","allocated","available","quarantinedOnHand"],"additionalProperties":false}},"meta":{"type":"object","properties":{"populationCount":{"type":"integer","minimum":0},"returnedRows":{"type":"integer","minimum":0},"hasMore":{"type":"boolean"},"nextCursor":{"type":["string","null"]},"ordering":{"type":"string","enum":["product_id_asc_warehouse_id_asc"]},"observedAt":{"type":"string","format":"date-time"},"currentState":{"type":"boolean","enum":[true]},"snapshotIsolatedAcrossRequests":{"type":"boolean","enum":[false]},"census":{"type":"object","properties":{"population":{"type":"string","enum":["participating_physical_inventory_pairs"]},"scope":{"type":"string","enum":["entity_filters_excluding_availability"]},"pairs":{"type":"object","properties":{"zeroOnHand":{"type":"integer","minimum":0},"fullyAllocated":{"type":"integer","minimum":0},"positiveAvailable":{"type":"integer","minimum":0},"zeroAvailable":{"type":"integer","minimum":0},"archived":{"type":"integer","minimum":0}},"required":["zeroOnHand","fullyAllocated","positiveAvailable","zeroAvailable","archived"],"additionalProperties":false},"products":{"type":"object","properties":{"withParticipatingPairs":{"type":"integer","minimum":0},"noneAvailableInScope":{"type":"integer","minimum":0}},"required":["withParticipatingPairs","noneAvailableInScope"],"additionalProperties":false}},"required":["population","scope","pairs","products"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["populationCount","returnedRows","hasMore","nextCursor","ordering","observedAt","currentState","snapshotIsolatedAcrossRequests","census","requestId"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/invoices":{"get":{"operationId":"findPublicAPIInvoices","summary":"Find invoices","description":"Finds stored financial documents or payments by identity, counterparty, currency, date, or exact amount in integer cents. The default page size is 25; continue with nextCursor by itself. Connected documents and payments are included when the key and acting person can read both resource families. Receivables follow the acting person's current customer and salesperson access.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"invoices:read","parameters":[{"schema":{"type":"string","format":"uuid"},"required":false,"name":"id","in":"query"},{"schema":{"type":"string","minLength":1,"maxLength":200},"required":false,"name":"number","in":"query"},{"schema":{"type":"string","format":"uuid"},"required":false,"name":"counterpartyId","in":"query"},{"schema":{"type":"string","pattern":"^[A-Z]{3}$"},"required":false,"name":"transactionCurrencyCode","in":"query"},{"schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"required":false,"name":"from","in":"query"},{"schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"required":false,"name":"to","in":"query"},{"schema":{"type":"string","pattern":"^-?\\d+$"},"required":false,"name":"amountCents","in":"query"},{"schema":{"type":"string","pattern":"^-?\\d+$"},"required":false,"name":"amountMinCents","in":"query"},{"schema":{"type":"string","pattern":"^-?\\d+$"},"required":false,"name":"amountMaxCents","in":"query"},{"schema":{"type":"string","pattern":"^(?:[1-9]\\d?|100)$"},"required":false,"name":"limit","in":"query"},{"schema":{"type":"string","minLength":1,"maxLength":4096},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"string","enum":["invoice","credit_note","bill","supplier_credit"]},"required":false,"name":"kind","in":"query"},{"schema":{"type":"string","enum":["total","open"]},"required":false,"name":"amountBasis","in":"query"},{"schema":{"type":"string","enum":["true","false"]},"required":false,"name":"openOnly","in":"query"}],"responses":{"200":{"description":"Current authorized financial facts.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"kind":{"type":"string","enum":["invoice","credit_note","bill","supplier_credit"]},"number":{"type":"string"},"status":{"type":"string"},"counterpartyId":{"type":"string","format":"uuid"},"counterpartyName":{"type":"string"},"counterpartyStatus":{"type":"string","enum":["active","prospect","archived"]},"transactionCurrencyCode":{"type":"string"},"totalAmountCents":{"type":"string","pattern":"^-?\\d+$"},"paidAmountCents":{"type":"string","pattern":"^-?\\d+$"},"openAmountCents":{"type":"string","pattern":"^-?\\d+$"},"baseOpenAmountCents":{"type":"string","pattern":"^-?\\d+$"},"documentDate":{"type":["string","null"],"format":"date-time"},"dueDate":{"type":["string","null"],"format":"date-time"},"paidDate":{"type":["string","null"],"format":"date-time"},"postedAt":{"type":["string","null"],"format":"date-time"},"voidedAt":{"type":["string","null"],"format":"date-time"},"openingBalance":{"type":"boolean"}},"required":["id","kind","number","status","counterpartyId","counterpartyName","counterpartyStatus","transactionCurrencyCode","totalAmountCents","paidAmountCents","openAmountCents","baseOpenAmountCents","documentDate","dueDate","paidDate","postedAt","voidedAt","openingBalance"],"additionalProperties":false}},"meta":{"type":"object","properties":{"nextCursor":{"type":["string","null"]},"requestId":{"type":"string"}},"required":["nextCursor","requestId"]}},"required":["data","meta"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/invoices/{id}":{"get":{"operationId":"getPublicAPIInvoicesDetail","summary":"Get invoices detail","description":"Returns one selected financial document or payment by ID. Connected financial details are included when the key and acting person can read the matching resource family.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"invoices:read","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Exact authorized financial detail.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"invoiceNo":{"type":"string","minLength":1,"maxLength":300},"externalId":{"type":["string","null"]},"customerId":{"type":"string","format":"uuid"},"counterpartyName":{"type":"string"},"counterpartyStatus":{"type":"string","enum":["active","prospect","archived"]},"paidDate":{"type":["string","null"],"format":"date-time"},"voidedAt":{"type":["string","null"],"format":"date-time"},"termsOfPayment":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"netDays":{"type":"integer"}},"required":["id","name","netDays"],"additionalProperties":false},"openingBalance":{"type":"boolean"},"accountingCutoverDay":{"type":["string","null"]},"appliedPayments":{"type":["array","null"],"items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"paymentNo":{"type":"string"},"routeId":{"type":["string","null"],"format":"uuid"},"paidAt":{"type":"string","format":"date-time"},"transactionCurrencyCode":{"type":"string","description":"Currency of the cash amount."},"documentCurrencyCode":{"type":"string","description":"Currency of the document discount or write-off amount."},"cashAmountCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"creditAmountCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"discountOrWriteOffAmountCents":{"type":"string","pattern":"^-?\\d+$"},"cashUnavailableReason":{"type":["string","null"],"enum":["legacy_mixed_cash_and_credit","mixed_cash_and_credit_attribution_unrecorded"]}},"required":["id","paymentNo","routeId","paidAt","transactionCurrencyCode","documentCurrencyCode","cashAmountCents","creditAmountCents","discountOrWriteOffAmountCents","cashUnavailableReason"],"additionalProperties":false}},"appliedPaymentsComplete":{"type":"boolean"},"status":{"type":"string","enum":["DRAFT","POSTED","PARTIALLY_PAID","PAID","VOID"]},"submittedDate":{"type":["string","null"],"format":"date-time"},"dueDate":{"type":["string","null"],"format":"date-time"},"postedAt":{"type":["string","null"],"format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["user"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["system"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string","enum":["System User"]}},"required":["type","id","displayName"],"additionalProperties":false}]},"money":{"type":"object","properties":{"totalAmountCents":{"type":"string","pattern":"^-?\\d+$"},"paidAmountCents":{"type":"string","pattern":"^-?\\d+$"},"openAmountCents":{"type":"string","pattern":"^-?\\d+$"},"resolvedCurrencyCode":{"type":"string","pattern":"^[A-Z]{3}$"}},"required":["totalAmountCents","paidAmountCents","openAmountCents","resolvedCurrencyCode"],"additionalProperties":false}},"required":["id","invoiceNo","externalId","customerId","counterpartyName","counterpartyStatus","paidDate","voidedAt","termsOfPayment","openingBalance","accountingCutoverDay","appliedPayments","appliedPaymentsComplete","status","submittedDate","dueDate","postedAt","updatedAt","createdAt","createdBy","money"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"kind":{"type":"string","enum":["invoice","credit_note","bill","supplier_credit"]},"number":{"type":"string"},"status":{"type":"string"},"counterpartyId":{"type":"string","format":"uuid"},"counterpartyName":{"type":"string"},"counterpartyStatus":{"type":"string","enum":["active","prospect","archived"]},"transactionCurrencyCode":{"type":"string"},"totalAmountCents":{"type":"string","pattern":"^-?\\d+$"},"paidAmountCents":{"type":"string","pattern":"^-?\\d+$"},"openAmountCents":{"type":"string","pattern":"^-?\\d+$"},"baseOpenAmountCents":{"type":"string","pattern":"^-?\\d+$"},"documentDate":{"type":["string","null"],"format":"date-time"},"dueDate":{"type":["string","null"],"format":"date-time"},"paidDate":{"type":["string","null"],"format":"date-time"},"postedAt":{"type":["string","null"],"format":"date-time"},"voidedAt":{"type":["string","null"],"format":"date-time"},"openingBalance":{"type":"boolean"}},"required":["id","kind","number","status","counterpartyId","counterpartyName","counterpartyStatus","transactionCurrencyCode","totalAmountCents","paidAmountCents","openAmountCents","baseOpenAmountCents","documentDate","dueDate","paidDate","postedAt","voidedAt","openingBalance"],"additionalProperties":false}]},"meta":{"type":"object","properties":{"requestId":{"type":"string"}},"required":["requestId"]}},"required":["data","meta"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/bills":{"get":{"operationId":"findPublicAPIBills","summary":"Find bills","description":"Finds stored financial documents or payments by identity, counterparty, currency, date, or exact amount in integer cents. The default page size is 25; continue with nextCursor by itself. Connected documents and payments are included when the key and acting person can read both resource families. Receivables follow the acting person's current customer and salesperson access.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"bills:read","parameters":[{"schema":{"type":"string","format":"uuid"},"required":false,"name":"id","in":"query"},{"schema":{"type":"string","minLength":1,"maxLength":200},"required":false,"name":"number","in":"query"},{"schema":{"type":"string","format":"uuid"},"required":false,"name":"counterpartyId","in":"query"},{"schema":{"type":"string","pattern":"^[A-Z]{3}$"},"required":false,"name":"transactionCurrencyCode","in":"query"},{"schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"required":false,"name":"from","in":"query"},{"schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"required":false,"name":"to","in":"query"},{"schema":{"type":"string","pattern":"^-?\\d+$"},"required":false,"name":"amountCents","in":"query"},{"schema":{"type":"string","pattern":"^-?\\d+$"},"required":false,"name":"amountMinCents","in":"query"},{"schema":{"type":"string","pattern":"^-?\\d+$"},"required":false,"name":"amountMaxCents","in":"query"},{"schema":{"type":"string","pattern":"^(?:[1-9]\\d?|100)$"},"required":false,"name":"limit","in":"query"},{"schema":{"type":"string","minLength":1,"maxLength":4096},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"string","enum":["invoice","credit_note","bill","supplier_credit"]},"required":false,"name":"kind","in":"query"},{"schema":{"type":"string","enum":["total","open"]},"required":false,"name":"amountBasis","in":"query"},{"schema":{"type":"string","enum":["true","false"]},"required":false,"name":"openOnly","in":"query"}],"responses":{"200":{"description":"Current authorized financial facts.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"kind":{"type":"string","enum":["invoice","credit_note","bill","supplier_credit"]},"number":{"type":"string"},"status":{"type":"string"},"counterpartyId":{"type":"string","format":"uuid"},"counterpartyName":{"type":"string"},"counterpartyStatus":{"type":"string","enum":["active","prospect","archived"]},"transactionCurrencyCode":{"type":"string"},"totalAmountCents":{"type":"string","pattern":"^-?\\d+$"},"paidAmountCents":{"type":"string","pattern":"^-?\\d+$"},"openAmountCents":{"type":"string","pattern":"^-?\\d+$"},"baseOpenAmountCents":{"type":"string","pattern":"^-?\\d+$"},"documentDate":{"type":["string","null"],"format":"date-time"},"dueDate":{"type":["string","null"],"format":"date-time"},"paidDate":{"type":["string","null"],"format":"date-time"},"postedAt":{"type":["string","null"],"format":"date-time"},"voidedAt":{"type":["string","null"],"format":"date-time"},"openingBalance":{"type":"boolean"}},"required":["id","kind","number","status","counterpartyId","counterpartyName","counterpartyStatus","transactionCurrencyCode","totalAmountCents","paidAmountCents","openAmountCents","baseOpenAmountCents","documentDate","dueDate","paidDate","postedAt","voidedAt","openingBalance"],"additionalProperties":false}},"meta":{"type":"object","properties":{"nextCursor":{"type":["string","null"]},"requestId":{"type":"string"}},"required":["nextCursor","requestId"]}},"required":["data","meta"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/bills/{id}":{"get":{"operationId":"getPublicAPIBillsDetail","summary":"Get bills detail","description":"Returns one selected financial document or payment by ID. Connected financial details are included when the key and acting person can read the matching resource family.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"bills:read","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Exact authorized financial detail.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"billNo":{"type":"string","minLength":1,"maxLength":300},"externalId":{"type":["string","null"]},"supplierId":{"type":"string","format":"uuid"},"counterpartyName":{"type":"string"},"counterpartyStatus":{"type":"string","enum":["active","prospect","archived"]},"paidDate":{"type":["string","null"],"format":"date-time"},"voidedAt":{"type":["string","null"],"format":"date-time"},"termsOfPayment":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"netDays":{"type":"integer"}},"required":["id","name","netDays"],"additionalProperties":false},"openingBalance":{"type":"boolean"},"accountingCutoverDay":{"type":["string","null"]},"appliedPayments":{"type":["array","null"],"items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"paymentNo":{"type":"string"},"routeId":{"type":["string","null"],"format":"uuid"},"paidAt":{"type":"string","format":"date-time"},"transactionCurrencyCode":{"type":"string","description":"Currency of the cash amount."},"documentCurrencyCode":{"type":"string","description":"Currency of the document discount or write-off amount."},"cashAmountCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"creditAmountCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"discountOrWriteOffAmountCents":{"type":"string","pattern":"^-?\\d+$"},"cashUnavailableReason":{"type":["string","null"],"enum":["legacy_mixed_cash_and_credit","mixed_cash_and_credit_attribution_unrecorded"]}},"required":["id","paymentNo","routeId","paidAt","transactionCurrencyCode","documentCurrencyCode","cashAmountCents","creditAmountCents","discountOrWriteOffAmountCents","cashUnavailableReason"],"additionalProperties":false}},"appliedPaymentsComplete":{"type":"boolean"},"status":{"type":"string","enum":["DRAFT","POSTED","PARTIALLY_PAID","PAID","VOID"]},"issuedDate":{"type":"string","format":"date-time"},"dueDate":{"type":"string","format":"date-time"},"postedAt":{"type":["string","null"],"format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["user"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["system"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string","enum":["System User"]}},"required":["type","id","displayName"],"additionalProperties":false}]},"money":{"type":"object","properties":{"itemsAmountCents":{"type":"string","pattern":"^-?\\d+$"},"paidAmountCents":{"type":"string","pattern":"^-?\\d+$"},"openAmountCents":{"type":"string","pattern":"^-?\\d+$"},"resolvedCurrencyCode":{"type":"string","pattern":"^[A-Z]{3}$"}},"required":["itemsAmountCents","paidAmountCents","openAmountCents","resolvedCurrencyCode"],"additionalProperties":false}},"required":["id","billNo","externalId","supplierId","counterpartyName","counterpartyStatus","paidDate","voidedAt","termsOfPayment","openingBalance","accountingCutoverDay","appliedPayments","appliedPaymentsComplete","status","issuedDate","dueDate","postedAt","updatedAt","createdAt","createdBy","money"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"kind":{"type":"string","enum":["invoice","credit_note","bill","supplier_credit"]},"number":{"type":"string"},"status":{"type":"string"},"counterpartyId":{"type":"string","format":"uuid"},"counterpartyName":{"type":"string"},"counterpartyStatus":{"type":"string","enum":["active","prospect","archived"]},"transactionCurrencyCode":{"type":"string"},"totalAmountCents":{"type":"string","pattern":"^-?\\d+$"},"paidAmountCents":{"type":"string","pattern":"^-?\\d+$"},"openAmountCents":{"type":"string","pattern":"^-?\\d+$"},"baseOpenAmountCents":{"type":"string","pattern":"^-?\\d+$"},"documentDate":{"type":["string","null"],"format":"date-time"},"dueDate":{"type":["string","null"],"format":"date-time"},"paidDate":{"type":["string","null"],"format":"date-time"},"postedAt":{"type":["string","null"],"format":"date-time"},"voidedAt":{"type":["string","null"],"format":"date-time"},"openingBalance":{"type":"boolean"}},"required":["id","kind","number","status","counterpartyId","counterpartyName","counterpartyStatus","transactionCurrencyCode","totalAmountCents","paidAmountCents","openAmountCents","baseOpenAmountCents","documentDate","dueDate","paidDate","postedAt","voidedAt","openingBalance"],"additionalProperties":false}]},"meta":{"type":"object","properties":{"requestId":{"type":"string"}},"required":["requestId"]}},"required":["data","meta"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/customer-payments":{"get":{"operationId":"findPublicAPICustomerPayments","summary":"Find customer payments","description":"Finds stored financial documents or payments by identity, counterparty, currency, date, or exact amount in integer cents. The default page size is 25; continue with nextCursor by itself. Connected documents and payments are included when the key and acting person can read both resource families. Receivables follow the acting person's current customer and salesperson access.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"customer-payments:read","parameters":[{"schema":{"type":"string","format":"uuid"},"required":false,"name":"id","in":"query"},{"schema":{"type":"string","minLength":1,"maxLength":200},"required":false,"name":"number","in":"query"},{"schema":{"type":"string","format":"uuid"},"required":false,"name":"counterpartyId","in":"query"},{"schema":{"type":"string","pattern":"^[A-Z]{3}$"},"required":false,"name":"transactionCurrencyCode","in":"query"},{"schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"required":false,"name":"from","in":"query"},{"schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"required":false,"name":"to","in":"query"},{"schema":{"type":"string","pattern":"^-?\\d+$"},"required":false,"name":"amountCents","in":"query"},{"schema":{"type":"string","pattern":"^-?\\d+$"},"required":false,"name":"amountMinCents","in":"query"},{"schema":{"type":"string","pattern":"^-?\\d+$"},"required":false,"name":"amountMaxCents","in":"query"},{"schema":{"type":"string","pattern":"^(?:[1-9]\\d?|100)$"},"required":false,"name":"limit","in":"query"},{"schema":{"type":"string","minLength":1,"maxLength":4096},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"string","format":"uuid"},"required":false,"name":"groupId","in":"query"}],"responses":{"200":{"description":"Current authorized financial facts.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"paymentNo":{"type":"string"},"counterpartyId":{"type":"string","format":"uuid"},"counterpartyName":{"type":"string"},"counterpartyStatus":{"type":"string","enum":["active","prospect","archived"]},"paidAt":{"type":"string","format":"date-time"},"transactionCurrencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"amountCents":{"type":"string"},"baseAmountCents":{"type":"string"},"method":{"type":"string"},"remainderTreatment":{"type":"string"},"keptOnAccountCents":{"type":"string"},"writtenOffCents":{"type":"string"},"depositId":{"type":["string","null"],"format":"uuid"},"depositNo":{"type":["string","null"]},"depositDate":{"type":["string","null"],"format":"date-time"},"depositAmountCents":{"type":["string","null"]},"depositCurrencyCode":{"type":["string","null"],"pattern":"^[A-Z]{3}$"},"depositPaymentCount":{"type":"integer","minimum":0},"matchedOn":{"type":"string","enum":["payment","deposit_total"]},"appliedDocuments":{"type":["array","null"],"items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"number":{"type":"string"},"transactionCurrencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"amountCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"paymentAmountCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"paymentCurrencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"documentAmountUnavailableReason":{"type":["string","null"],"enum":["legacy_cross_currency_document_amount"]},"discountOrWriteOffAmountCents":{"type":"string","pattern":"^-?\\d+$"},"unavailableReason":{"type":["string","null"],"enum":["legacy_mixed_cash_and_credit","mixed_cash_and_credit_attribution_unrecorded"]}},"required":["id","number","transactionCurrencyCode","amountCents","paymentAmountCents","paymentCurrencyCode","documentAmountUnavailableReason","discountOrWriteOffAmountCents","unavailableReason"],"additionalProperties":false},"maxItems":501},"creditsUsed":{"type":["array","null"],"items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"number":{"type":"string"},"transactionCurrencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"amountCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"unavailableReason":{"type":["string","null"],"enum":["legacy_cross_currency_document_amount"]}},"required":["id","number","transactionCurrencyCode","amountCents","unavailableReason"],"additionalProperties":false},"maxItems":501},"appliedDocumentCount":{"type":["integer","null"],"minimum":0},"preGoLive":{"type":"boolean"},"appliedDocumentsComplete":{"type":["boolean","null"]},"creditsUsedComplete":{"type":["boolean","null"]}},"required":["id","paymentNo","counterpartyId","counterpartyName","counterpartyStatus","paidAt","transactionCurrencyCode","amountCents","baseAmountCents","method","remainderTreatment","keptOnAccountCents","writtenOffCents","depositId","depositNo","depositDate","depositAmountCents","depositCurrencyCode","depositPaymentCount","matchedOn","appliedDocuments","creditsUsed","appliedDocumentCount","preGoLive","appliedDocumentsComplete","creditsUsedComplete"],"additionalProperties":false}},"meta":{"type":"object","properties":{"nextCursor":{"type":["string","null"]},"requestId":{"type":"string"}},"required":["nextCursor","requestId"]}},"required":["data","meta"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/customer-payments/{id}":{"get":{"operationId":"getPublicAPICustomerPaymentsDetail","summary":"Get customer payments detail","description":"Returns one selected financial document or payment by ID. Connected financial details are included when the key and acting person can read the matching resource family.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"customer-payments:read","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Exact authorized financial detail.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"paymentNo":{"type":"string"},"counterpartyId":{"type":"string","format":"uuid"},"counterpartyName":{"type":"string"},"counterpartyStatus":{"type":"string","enum":["active","prospect","archived"]},"paidAt":{"type":"string","format":"date-time"},"transactionCurrencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"amountCents":{"type":"string"},"baseAmountCents":{"type":"string"},"method":{"type":"string"},"remainderTreatment":{"type":"string"},"keptOnAccountCents":{"type":"string"},"writtenOffCents":{"type":"string"},"depositId":{"type":["string","null"],"format":"uuid"},"depositNo":{"type":["string","null"]},"depositDate":{"type":["string","null"],"format":"date-time"},"depositAmountCents":{"type":["string","null"]},"depositCurrencyCode":{"type":["string","null"],"pattern":"^[A-Z]{3}$"},"depositPaymentCount":{"type":"integer","minimum":0},"matchedOn":{"type":"string","enum":["payment","deposit_total"]},"appliedDocuments":{"type":["array","null"],"items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"number":{"type":"string"},"transactionCurrencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"amountCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"paymentAmountCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"paymentCurrencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"documentAmountUnavailableReason":{"type":["string","null"],"enum":["legacy_cross_currency_document_amount"]},"discountOrWriteOffAmountCents":{"type":"string","pattern":"^-?\\d+$"},"unavailableReason":{"type":["string","null"],"enum":["legacy_mixed_cash_and_credit","mixed_cash_and_credit_attribution_unrecorded"]}},"required":["id","number","transactionCurrencyCode","amountCents","paymentAmountCents","paymentCurrencyCode","documentAmountUnavailableReason","discountOrWriteOffAmountCents","unavailableReason"],"additionalProperties":false},"maxItems":501},"creditsUsed":{"type":["array","null"],"items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"number":{"type":"string"},"transactionCurrencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"amountCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"unavailableReason":{"type":["string","null"],"enum":["legacy_cross_currency_document_amount"]}},"required":["id","number","transactionCurrencyCode","amountCents","unavailableReason"],"additionalProperties":false},"maxItems":501},"appliedDocumentCount":{"type":["integer","null"],"minimum":0},"preGoLive":{"type":"boolean"},"appliedDocumentsComplete":{"type":["boolean","null"]},"creditsUsedComplete":{"type":["boolean","null"]}},"required":["id","paymentNo","counterpartyId","counterpartyName","counterpartyStatus","paidAt","transactionCurrencyCode","amountCents","baseAmountCents","method","remainderTreatment","keptOnAccountCents","writtenOffCents","depositId","depositNo","depositDate","depositAmountCents","depositCurrencyCode","depositPaymentCount","matchedOn","appliedDocuments","creditsUsed","appliedDocumentCount","preGoLive","appliedDocumentsComplete","creditsUsedComplete"],"additionalProperties":false},"meta":{"type":"object","properties":{"requestId":{"type":"string"}},"required":["requestId"]}},"required":["data","meta"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/supplier-payments":{"get":{"operationId":"findPublicAPISupplierPayments","summary":"Find supplier payments","description":"Finds stored financial documents or payments by identity, counterparty, currency, date, or exact amount in integer cents. The default page size is 25; continue with nextCursor by itself. Connected documents and payments are included when the key and acting person can read both resource families. Receivables follow the acting person's current customer and salesperson access.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"supplier-payments:read","parameters":[{"schema":{"type":"string","format":"uuid"},"required":false,"name":"id","in":"query"},{"schema":{"type":"string","minLength":1,"maxLength":200},"required":false,"name":"number","in":"query"},{"schema":{"type":"string","format":"uuid"},"required":false,"name":"counterpartyId","in":"query"},{"schema":{"type":"string","pattern":"^[A-Z]{3}$"},"required":false,"name":"transactionCurrencyCode","in":"query"},{"schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"required":false,"name":"from","in":"query"},{"schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"required":false,"name":"to","in":"query"},{"schema":{"type":"string","pattern":"^-?\\d+$"},"required":false,"name":"amountCents","in":"query"},{"schema":{"type":"string","pattern":"^-?\\d+$"},"required":false,"name":"amountMinCents","in":"query"},{"schema":{"type":"string","pattern":"^-?\\d+$"},"required":false,"name":"amountMaxCents","in":"query"},{"schema":{"type":"string","pattern":"^(?:[1-9]\\d?|100)$"},"required":false,"name":"limit","in":"query"},{"schema":{"type":"string","minLength":1,"maxLength":4096},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"string","format":"uuid"},"required":false,"name":"groupId","in":"query"}],"responses":{"200":{"description":"Current authorized financial facts.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"paymentNo":{"type":"string"},"counterpartyId":{"type":"string","format":"uuid"},"counterpartyName":{"type":"string"},"counterpartyStatus":{"type":"string","enum":["active","archived"]},"paidAt":{"type":"string","format":"date-time"},"transactionCurrencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"amountCents":{"type":"string"},"baseAmountCents":{"type":"string"},"discountAmountCents":{"type":"string"},"batchId":{"type":"string","format":"uuid"},"batchNo":{"type":"string"},"batchAmountCents":{"type":"string"},"batchCurrencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"bankAccountName":{"type":"string"},"paymentFile":{"type":["string","null"],"enum":["ach","check"]},"matchedOn":{"type":"string","enum":["payment","batch_total"]},"appliedDocuments":{"type":["array","null"],"items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"number":{"type":"string"},"transactionCurrencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"amountCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"paymentAmountCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"paymentCurrencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"documentAmountUnavailableReason":{"type":["string","null"],"enum":["legacy_cross_currency_document_amount"]},"discountOrWriteOffAmountCents":{"type":"string","pattern":"^-?\\d+$"},"unavailableReason":{"type":["string","null"],"enum":["legacy_mixed_cash_and_credit","mixed_cash_and_credit_attribution_unrecorded"]}},"required":["id","number","transactionCurrencyCode","amountCents","paymentAmountCents","paymentCurrencyCode","documentAmountUnavailableReason","discountOrWriteOffAmountCents","unavailableReason"],"additionalProperties":false},"maxItems":501},"creditsUsed":{"type":["array","null"],"items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"number":{"type":"string"},"transactionCurrencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"amountCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"unavailableReason":{"type":["string","null"],"enum":["legacy_cross_currency_document_amount"]}},"required":["id","number","transactionCurrencyCode","amountCents","unavailableReason"],"additionalProperties":false},"maxItems":501},"appliedDocumentCount":{"type":["integer","null"],"minimum":0},"preGoLive":{"type":"boolean"},"appliedDocumentsComplete":{"type":["boolean","null"]},"creditsUsedComplete":{"type":["boolean","null"]}},"required":["id","paymentNo","counterpartyId","counterpartyName","counterpartyStatus","paidAt","transactionCurrencyCode","amountCents","baseAmountCents","discountAmountCents","batchId","batchNo","batchAmountCents","batchCurrencyCode","bankAccountName","paymentFile","matchedOn","appliedDocuments","creditsUsed","appliedDocumentCount","preGoLive","appliedDocumentsComplete","creditsUsedComplete"],"additionalProperties":false}},"meta":{"type":"object","properties":{"nextCursor":{"type":["string","null"]},"requestId":{"type":"string"}},"required":["nextCursor","requestId"]}},"required":["data","meta"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/supplier-payments/{id}":{"get":{"operationId":"getPublicAPISupplierPaymentsDetail","summary":"Get supplier payments detail","description":"Returns one selected financial document or payment by ID. Connected financial details are included when the key and acting person can read the matching resource family.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"supplier-payments:read","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Exact authorized financial detail.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"paymentNo":{"type":"string"},"counterpartyId":{"type":"string","format":"uuid"},"counterpartyName":{"type":"string"},"counterpartyStatus":{"type":"string","enum":["active","archived"]},"paidAt":{"type":"string","format":"date-time"},"transactionCurrencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"amountCents":{"type":"string"},"baseAmountCents":{"type":"string"},"discountAmountCents":{"type":"string"},"batchId":{"type":"string","format":"uuid"},"batchNo":{"type":"string"},"batchAmountCents":{"type":"string"},"batchCurrencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"bankAccountName":{"type":"string"},"paymentFile":{"type":["string","null"],"enum":["ach","check"]},"matchedOn":{"type":"string","enum":["payment","batch_total"]},"appliedDocuments":{"type":["array","null"],"items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"number":{"type":"string"},"transactionCurrencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"amountCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"paymentAmountCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"paymentCurrencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"documentAmountUnavailableReason":{"type":["string","null"],"enum":["legacy_cross_currency_document_amount"]},"discountOrWriteOffAmountCents":{"type":"string","pattern":"^-?\\d+$"},"unavailableReason":{"type":["string","null"],"enum":["legacy_mixed_cash_and_credit","mixed_cash_and_credit_attribution_unrecorded"]}},"required":["id","number","transactionCurrencyCode","amountCents","paymentAmountCents","paymentCurrencyCode","documentAmountUnavailableReason","discountOrWriteOffAmountCents","unavailableReason"],"additionalProperties":false},"maxItems":501},"creditsUsed":{"type":["array","null"],"items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"number":{"type":"string"},"transactionCurrencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"amountCents":{"type":["string","null"],"pattern":"^-?\\d+$"},"unavailableReason":{"type":["string","null"],"enum":["legacy_cross_currency_document_amount"]}},"required":["id","number","transactionCurrencyCode","amountCents","unavailableReason"],"additionalProperties":false},"maxItems":501},"appliedDocumentCount":{"type":["integer","null"],"minimum":0},"preGoLive":{"type":"boolean"},"appliedDocumentsComplete":{"type":["boolean","null"]},"creditsUsedComplete":{"type":["boolean","null"]}},"required":["id","paymentNo","counterpartyId","counterpartyName","counterpartyStatus","paidAt","transactionCurrencyCode","amountCents","baseAmountCents","discountAmountCents","batchId","batchNo","batchAmountCents","batchCurrencyCode","bankAccountName","paymentFile","matchedOn","appliedDocuments","creditsUsed","appliedDocumentCount","preGoLive","appliedDocumentsComplete","creditsUsedComplete"],"additionalProperties":false},"meta":{"type":"object","properties":{"requestId":{"type":"string"}},"required":["requestId"]}},"required":["data","meta"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/lots":{"get":{"operationId":"findPublicAPILots","summary":"Find lots","description":"Finds named lots with exact stored quantities in each row's stated quantity basis. Each row includes lot state, product, warehouse, available dates, COA readiness, and remaining-stock age. coaAttached is true when that lot has its own usable COA attachment. Continue with the exact returned cursor.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"lots:read","parameters":[{"schema":{"type":"string","minLength":1,"maxLength":120},"required":false,"name":"search","in":"query"},{"schema":{"type":"string","maxLength":300},"required":false,"name":"lotNumber","in":"query"},{"schema":{"type":"string","format":"uuid"},"required":false,"name":"productId","in":"query"},{"schema":{"type":"string","format":"uuid"},"required":false,"name":"packagingId","in":"query"},{"schema":{"type":"string","format":"uuid"},"required":false,"name":"warehouseId","in":"query"},{"schema":{"type":"string","format":"uuid"},"required":false,"name":"supplierId","in":"query"},{"schema":{"type":"string","format":"uuid"},"required":false,"name":"createdById","in":"query"},{"schema":{"type":"string","format":"date-time"},"required":false,"name":"createdFrom","in":"query"},{"schema":{"type":"string","format":"date-time"},"required":false,"name":"createdTo","in":"query"},{"schema":{"type":"string","enum":["AVAILABLE","QUARANTINED"]},"required":false,"name":"lotStateCode","in":"query"},{"schema":{"type":"string","enum":["qtyOnOrder","qtyOnHand","qtyAllocated","qtyAvailable"]},"required":false,"name":"quantityField","in":"query"},{"schema":{"type":"string","pattern":"^\\d+(?:\\.\\d+)?$"},"required":false,"name":"minimumQuantity","in":"query"},{"schema":{"type":"string","pattern":"^\\d+(?:\\.\\d+)?$"},"required":false,"name":"maximumQuantity","in":"query"},{"schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"required":false,"name":"oldestOnHandAddedBefore","in":"query"},{"schema":{"type":"string","enum":["true","false"]},"required":false,"name":"includeOnOrder","in":"query"},{"schema":{"type":"string","enum":["true","false"]},"required":false,"name":"includeDepleted","in":"query"},{"schema":{"type":"string","enum":["true","false"]},"required":false,"name":"includePlaceholders","in":"query"},{"schema":{"type":"string","pattern":"^\\d+$"},"required":false,"name":"limit","in":"query"},{"schema":{"type":"string","minLength":1,"maxLength":4096},"required":false,"name":"cursor","in":"query"}],"responses":{"200":{"description":"Named lots with current quantities and remaining-stock age.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"createdBy":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["user"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["system"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string","enum":["System User"]}},"required":["type","id","displayName"],"additionalProperties":false}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"lotNumber":{"type":"string"},"placeholder":{"type":"boolean"},"catalogPackaging":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","minLength":1}},"required":["id","name"],"additionalProperties":false},"warehouse":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","minLength":1},"archived":{"type":"boolean"},"directShip":{"type":"boolean"}},"required":["id","name","archived","directShip"],"additionalProperties":false},"supplier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","minLength":1}},"required":["id","name"],"additionalProperties":false},"lotState":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","minLength":1},"code":{"type":["string","null"],"enum":["AVAILABLE","QUARANTINED"]}},"required":["id","name","code"],"additionalProperties":false},"quarantined":{"type":"boolean"},"quantityBasis":{"type":"object","properties":{"type":{"type":"string","enum":["package_count","base_uom"]},"unitOfMeasure":{"type":"string","minLength":1}},"required":["type","unitOfMeasure"],"additionalProperties":false},"quantities":{"type":"object","properties":{"qtyOnOrder":{"type":"string","pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d*[1-9])?$"},"qtyOnHand":{"type":"string","pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d*[1-9])?$"},"qtyAllocated":{"type":"string","pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d*[1-9])?$"},"qtyAvailable":{"type":"string","pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d*[1-9])?$"}},"required":["qtyOnOrder","qtyOnHand","qtyAllocated","qtyAvailable"],"additionalProperties":false},"manufactureDate":{"type":["string","null"],"format":"date-time"},"expirationDate":{"type":["string","null"],"format":"date-time"},"ageEvidence":{"type":"object","properties":{"recordedAddedAt":{"type":["string","null"],"format":"date-time"},"recordedAddedOn":{"type":["string","null"],"pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"cutoverEvidence":{"type":"string","enum":["none","org_day_equals_cutover","utc_midnight_date_equals_cutover","both"]},"ageUnavailableReason":{"type":"string","enum":["none","no_on_hand","pending_only","virtual_or_inconsistent","uncertifiable"]}},"required":["recordedAddedAt","recordedAddedOn","cutoverEvidence","ageUnavailableReason"],"additionalProperties":false},"limitations":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["unexplained_on_order","unexplained_allocated"]},"quantity":{"type":"string","enum":["qtyOnOrder","qtyAllocated"]},"stored":{"type":"string","pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d*[1-9])?$"},"explained":{"type":"string","pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d*[1-9])?$"}},"required":["code","quantity","stored","explained"],"additionalProperties":false}},"coaAttached":{"type":"boolean"},"type":{"type":"string","enum":["lot"]},"product":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"code":{"type":"string"},"archived":{"type":"boolean"}},"required":["id","code","archived"],"additionalProperties":false}},"required":["createdBy","createdAt","id","lotNumber","placeholder","catalogPackaging","warehouse","lotState","quarantined","quantityBasis","quantities","manufactureDate","expirationDate","ageEvidence","limitations","coaAttached","type","product"],"additionalProperties":false}},"meta":{"type":"object","properties":{"populationCount":{"type":"integer","minimum":0},"returnedRows":{"type":"integer","minimum":0},"hasMore":{"type":"boolean"},"recordedDateMatchLotCount":{"type":"integer","minimum":0},"unresolvedAgeLotCount":{"type":"integer","minimum":0},"nextCursor":{"type":["string","null"]},"ordering":{"type":"string","enum":["product_id_asc_warehouse_id_asc_lot_number_asc_id_asc"]},"observedAt":{"type":"string","format":"date-time"},"currentState":{"type":"boolean","enum":[true]},"snapshotIsolatedAcrossRequests":{"type":"boolean","enum":[false]},"requestId":{"type":"string"}},"required":["populationCount","returnedRows","hasMore","recordedDateMatchLotCount","unresolvedAgeLotCount","nextCursor","ordering","observedAt","currentState","snapshotIsolatedAcrossRequests","requestId"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/lots/{id}":{"get":{"operationId":"getPublicAPILotDetail","summary":"Get lot detail","description":"Returns one selected lot with its quantities, state, COA readiness, recorded stock age, and the oldest remaining inventory additions that explain that age. coaAttached is true when that lot has its own usable COA attachment.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"lots:read","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Exact lot detail.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"createdBy":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["user"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["system"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string","enum":["System User"]}},"required":["type","id","displayName"],"additionalProperties":false}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"lotNumber":{"type":"string"},"placeholder":{"type":"boolean"},"catalogPackaging":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","minLength":1}},"required":["id","name"],"additionalProperties":false},"warehouse":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","minLength":1},"archived":{"type":"boolean"},"directShip":{"type":"boolean"}},"required":["id","name","archived","directShip"],"additionalProperties":false},"supplier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","minLength":1}},"required":["id","name"],"additionalProperties":false},"lotState":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","minLength":1},"code":{"type":["string","null"],"enum":["AVAILABLE","QUARANTINED"]}},"required":["id","name","code"],"additionalProperties":false},"quarantined":{"type":"boolean"},"quantityBasis":{"type":"object","properties":{"type":{"type":"string","enum":["package_count","base_uom"]},"unitOfMeasure":{"type":"string","minLength":1}},"required":["type","unitOfMeasure"],"additionalProperties":false},"quantities":{"type":"object","properties":{"qtyOnOrder":{"type":"string","pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d*[1-9])?$"},"qtyOnHand":{"type":"string","pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d*[1-9])?$"},"qtyAllocated":{"type":"string","pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d*[1-9])?$"},"qtyAvailable":{"type":"string","pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d*[1-9])?$"}},"required":["qtyOnOrder","qtyOnHand","qtyAllocated","qtyAvailable"],"additionalProperties":false},"manufactureDate":{"type":["string","null"],"format":"date-time"},"expirationDate":{"type":["string","null"],"format":"date-time"},"ageEvidence":{"type":"object","properties":{"recordedAddedAt":{"type":["string","null"],"format":"date-time"},"recordedAddedOn":{"type":["string","null"],"pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"cutoverEvidence":{"type":"string","enum":["none","org_day_equals_cutover","utc_midnight_date_equals_cutover","both"]},"ageUnavailableReason":{"type":"string","enum":["none","no_on_hand","pending_only","virtual_or_inconsistent","uncertifiable"]}},"required":["recordedAddedAt","recordedAddedOn","cutoverEvidence","ageUnavailableReason"],"additionalProperties":false},"limitations":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["unexplained_on_order","unexplained_allocated"]},"quantity":{"type":"string","enum":["qtyOnOrder","qtyAllocated"]},"stored":{"type":"string","pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d*[1-9])?$"},"explained":{"type":"string","pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d*[1-9])?$"}},"required":["code","quantity","stored","explained"],"additionalProperties":false}},"coaAttached":{"type":"boolean"},"type":{"type":"string","enum":["lot"]},"product":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"code":{"type":"string"},"archived":{"type":"boolean"}},"required":["id","code","archived"],"additionalProperties":false},"remainingPhysicalPackagingId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string","enum":["MIXED"]},{"type":"string","enum":["UNKNOWN"]}]},"remainingPhysicalLayers":{"type":"array","items":{"type":"object","properties":{"receiptId":{"type":"string","format":"uuid"},"recordedAddedAt":{"type":"string","format":"date-time"},"recordedAddedOn":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"originalQuantity":{"type":"string","pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d*[1-9])?$"},"remainingQuantity":{"type":"string","pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d*[1-9])?$"},"productPackagingId":{"type":["string","null"],"format":"uuid"},"capacityUOM":{"type":["string","null"],"pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d*[1-9])?$"},"sourceKind":{"type":"string","enum":["unclassified","purchase_order","production"]}},"required":["receiptId","recordedAddedAt","recordedAddedOn","originalQuantity","remainingQuantity","productPackagingId","capacityUOM","sourceKind"],"additionalProperties":false}},"layerCoverage":{"type":"object","properties":{"remainingLayerCount":{"type":"integer","minimum":0},"returnedLayers":{"type":"integer","minimum":0},"truncated":{"type":"boolean"}},"required":["remainingLayerCount","returnedLayers","truncated"],"additionalProperties":false}},"required":["createdBy","createdAt","id","lotNumber","placeholder","catalogPackaging","warehouse","lotState","quarantined","quantityBasis","quantities","manufactureDate","expirationDate","ageEvidence","limitations","coaAttached","type","product","remainingPhysicalPackagingId","remainingPhysicalLayers","layerCoverage"],"additionalProperties":false},"meta":{"type":"object","properties":{"observedAt":{"type":"string","format":"date-time"},"currentState":{"type":"boolean","enum":[true]},"snapshotIsolatedAcrossRequests":{"type":"boolean","enum":[false]},"requestId":{"type":"string"}},"required":["observedAt","currentState","snapshotIsolatedAcrossRequests","requestId"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/reorder-status":{"get":{"operationId":"findPublicAPIReorderStatus","summary":"Find reorder status","description":"Returns configured reorder thresholds, current quantities, allocated and committed demand, projected availability, the gap to each threshold, status counts, and configured-product coverage. Projected deficit shows the gap to the configured threshold in the row's quantity basis. Projected availability reflects current stock after allocated and committed demand. Continue with the signed cursor alone.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"reorder:read","parameters":[{"schema":{"type":"string","format":"uuid"},"required":false,"name":"productId","in":"query"},{"schema":{"type":"string","format":"uuid"},"required":false,"name":"productFamilyId","in":"query"},{"schema":{"type":"string","format":"uuid"},"required":false,"name":"warehouseId","in":"query"},{"schema":{"type":"string","enum":["below_on_hand","below_projected","ok"]},"required":false,"name":"status","in":"query"},{"schema":{"type":"string","pattern":"^(?:[1-9]\\d?|100)$"},"required":false,"name":"limit","in":"query"},{"schema":{"type":"string"},"required":false,"name":"cursor","in":"query"}],"responses":{"200":{"description":"Current configured reorder status.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["reorder_status"]},"product":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"code":{"type":"string"},"family":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false}},"required":["id","code","family"],"additionalProperties":false},"warehouse":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false},"basis":{"type":"object","properties":{"type":{"type":"string","enum":["package_count","base_uom"]},"unitOfMeasure":{"type":"string"},"packaging":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false}},"required":["type","unitOfMeasure","packaging"],"additionalProperties":false},"reorderPoint":{"type":"string","pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d*[1-9])?$"},"onHand":{"type":"string","pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d*[1-9])?$"},"allocated":{"type":"string","pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d*[1-9])?$"},"committed":{"type":"string","pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d*[1-9])?$"},"projectedAvailable":{"type":"string","pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d*[1-9])?$"},"projectedDeficit":{"type":"string","pattern":"^(?:0|[1-9]\\d*)(?:\\.\\d*[1-9])?$","description":"Nonnegative gap between the configured reorder point and projected available quantity, in this row's package-count or base-UOM basis. This is not a recommended order quantity."},"status":{"type":"string","enum":["below_on_hand","below_projected","ok"]}},"required":["type","product","warehouse","basis","reorderPoint","onHand","allocated","committed","projectedAvailable","projectedDeficit","status"],"additionalProperties":false}},"meta":{"type":"object","properties":{"configuredRows":{"type":"integer","minimum":0},"returnedRows":{"type":"integer","minimum":0},"hasMore":{"type":"boolean"},"statusCounts":{"type":"object","properties":{"scope":{"type":"string","enum":["entity_filters_excluding_status"]},"belowOnHand":{"type":"integer","minimum":0},"belowProjected":{"type":"integer","minimum":0},"ok":{"type":"integer","minimum":0}},"required":["scope","belowOnHand","belowProjected","ok"],"additionalProperties":false},"configuredCoverage":{"type":"object","properties":{"configuredProducts":{"type":"integer","minimum":0},"activeProducts":{"type":"integer","minimum":0},"excludedArchivedConfigured":{"type":"integer","minimum":0},"excludedDirectShipConfigured":{"type":"integer","minimum":0}},"required":["configuredProducts","activeProducts","excludedArchivedConfigured","excludedDirectShipConfigured"],"additionalProperties":false},"nextCursor":{"type":["string","null"]},"ordering":{"type":"string","enum":["product_id_asc_warehouse_id_asc"]},"observedAt":{"type":"string","format":"date-time"},"currentState":{"type":"boolean","enum":[true]},"snapshotIsolatedAcrossRequests":{"type":"boolean","enum":[false]},"requestId":{"type":"string"}},"required":["configuredRows","returnedRows","hasMore","statusCounts","configuredCoverage","nextCursor","ordering","observedAt","currentState","snapshotIsolatedAcrossRequests","requestId"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/certification-types":{"get":{"operationId":"listPublicAPICertificationTypes","summary":"List certification types","description":"Lists the certification types available to the current connection, including expiration-notice settings. Warehouse types also require warehouses:read. Add includeDisabled=true when historical type configuration is needed. Continue with the returned meta.nextCursor by itself.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"certifications:read","parameters":[{"schema":{"type":"string","enum":["supplier","customer","product","customer_address","warehouse","supplier_combination"]},"required":false,"name":"subjectType","in":"query"},{"schema":{"type":"string","enum":["true","false"]},"required":false,"name":"includeDisabled","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":100,"default":25},"required":false,"name":"limit","in":"query"},{"schema":{"type":"string","minLength":1,"maxLength":4096},"required":false,"name":"cursor","in":"query"}],"responses":{"200":{"description":"Certification type page.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"title":{"type":"string","minLength":1},"description":{"type":"string"},"enabled":{"type":"boolean"},"documentationRequired":{"type":"boolean"},"expiryNoticeDaysBefore":{"type":["integer","null"]},"subjectType":{"type":"string","enum":["supplier","customer","product","customer_address","warehouse","supplier_combination"]},"type":{"type":"string","enum":["certification_type"]}},"required":["id","title","description","enabled","documentationRequired","expiryNoticeDaysBefore","subjectType","type"],"additionalProperties":false}},"meta":{"type":"object","properties":{"capabilityKey":{"type":"string","enum":["list_certification_types"]},"returnedRecords":{"type":"integer","minimum":0},"populationCount":{"type":["integer","null"],"minimum":0},"complete":{"type":"boolean"},"hasMore":{"type":"boolean"},"nextCursor":{"type":["string","null"]},"ordering":{"type":"string","enum":["title_id","valid_to_nulls_last_record_id","subject_type_subject_id_ship_from_product"]},"currentState":{"type":"boolean","enum":[true]},"snapshotIsolatedAcrossRequests":{"type":"boolean","enum":[false]},"requestId":{"type":"string"},"evaluatedAt":{"type":"string","format":"date-time"},"coverage":{"type":"object","properties":{"evaluatedAt":{"type":"string","format":"date-time"},"organizationId":{"type":"string","format":"uuid"},"organizationScoped":{"type":"boolean","enum":[true]},"currentState":{"type":"boolean","enum":[true]},"snapshotIsolatedAcrossRequests":{"type":"boolean","enum":[false]},"placeholderExcluded":{"type":"boolean"},"archivedExcluded":{"type":"boolean"},"searchedFields":{"type":"array","items":{"type":"string","minLength":1}},"requestedLanes":{"type":"array","items":{"type":"string","enum":["supplier","customer","product","customer_address","warehouse","supplier_combination"]}},"lanes":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"subjectType":{"type":"string","enum":["supplier","customer","product","customer_address","warehouse","supplier_combination"]},"status":{"type":"string","enum":["executed"]},"populationCount":{"type":["integer","null"],"minimum":0}},"required":["subjectType","status","populationCount"],"additionalProperties":false},{"type":"object","properties":{"subjectType":{"type":"string","enum":["supplier","customer","product","customer_address","warehouse","supplier_combination"]},"status":{"type":"string","enum":["denied"]}},"required":["subjectType","status"],"additionalProperties":false},{"type":"object","properties":{"subjectType":{"type":"string","enum":["supplier","customer","product","customer_address","warehouse","supplier_combination"]},"status":{"type":"string","enum":["unsupported"]}},"required":["subjectType","status"],"additionalProperties":false}]}},"appliedFilters":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","enum":["types"]},"subjectType":{"type":["string","null"],"enum":["supplier","customer","product","customer_address","warehouse","supplier_combination"]},"includeDisabled":{"type":"boolean"}},"required":["kind","subjectType","includeDisabled"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","enum":["records"]},"typeId":{"type":["string","null"],"format":"uuid"},"typeQuery":{"type":["string","null"],"minLength":1,"maxLength":120},"evidenceFileNameQuery":{"type":["string","null"],"minLength":1,"maxLength":240},"subjectTypes":{"type":["array","null"],"items":{"type":"string","enum":["supplier","customer","product","customer_address","warehouse","supplier_combination"]},"minItems":1,"maxItems":6},"subjectId":{"type":["string","null"],"format":"uuid"},"recordedStatuses":{"type":["array","null"],"items":{"type":"string","enum":["PENDING","ACTIVE","EXPIRED"]},"minItems":1,"maxItems":3},"effectiveStates":{"type":["array","null"],"items":{"type":"string","enum":["pending","current","expired","incomplete"]},"minItems":1,"maxItems":4},"expiresAtOrAfter":{"type":["string","null"],"format":"date-time"},"expiresAtOrBefore":{"type":["string","null"],"format":"date-time"},"evidenceRecordedState":{"type":["string","null"],"enum":["recorded","not_recorded","invalid_metadata"]},"includePlaceholders":{"type":"boolean"},"includeArchived":{"type":"boolean"},"renewalStates":{"type":["array","null"],"items":{"type":"string","enum":["current","expiring","expired","renewed","not_tracked"]},"minItems":1,"maxItems":5}},"required":["kind","typeId","typeQuery","evidenceFileNameQuery","subjectTypes","subjectId","recordedStatuses","effectiveStates","expiresAtOrAfter","expiresAtOrBefore","evidenceRecordedState","includePlaceholders","includeArchived","renewalStates"],"additionalProperties":false}]},"totalRecords":{"type":["integer","null"],"minimum":0},"returnedRecords":{"type":"integer","minimum":0}},"required":["evaluatedAt","organizationId","organizationScoped","currentState","snapshotIsolatedAcrossRequests","placeholderExcluded","archivedExcluded","searchedFields","requestedLanes","lanes","appliedFilters","totalRecords","returnedRecords"],"additionalProperties":false},"capabilityVersion":{"type":"string","enum":["1.1.0"]}},"required":["capabilityKey","returnedRecords","populationCount","complete","hasMore","nextCursor","ordering","currentState","snapshotIsolatedAcrossRequests","requestId","evaluatedAt","coverage","capabilityVersion"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Certification-type finder validation failed.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false},"examples":{"invalid-cursor":{"summary":"A certification-type cursor was combined with a limit","value":{"error":{"type":"validation_error","code":"invalid_cursor","message":"Cursor is invalid for this API key, organization, capability version, and certification filter set.","param":"cursor","retryable":false,"doNotRetrySameRequest":true,"requestId":"req-example"}}},"invalid-limit":{"summary":"The certification-type limit is outside the supported range","value":{"error":{"type":"validation_error","code":"validation_failed","message":"Request validation failed.","param":"limit","errors":[{"path":"limit","message":"Number must be less than or equal to 100"}],"acceptedFilters":["subjectType","includeDisabled","limit","cursor"],"requestId":"req-example"}}}}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/certification-records":{"get":{"operationId":"findPublicAPICertificationRecords","summary":"Find stored certification records","description":"Finds stored certification records for available suppliers, customers, products, customer addresses, warehouses, and supplier-product combinations. Results include effective and renewal states, days left, type notice settings, dates, and recorded evidence filenames. Warehouse results also require warehouses:read. Continue with the returned cursor by itself.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"certifications:read","parameters":[{"schema":{"type":"string","format":"uuid"},"required":false,"name":"typeId","in":"query"},{"schema":{"type":"string","minLength":1},"required":false,"name":"typeQuery","in":"query"},{"schema":{"type":"string","minLength":1},"required":false,"name":"evidenceFileNameQuery","in":"query"},{"schema":{"type":["array","null"],"items":{"type":"string","enum":["supplier","customer","product","customer_address","warehouse","supplier_combination"]},"minItems":1,"maxItems":6},"required":false,"name":"subjectTypes","in":"query"},{"schema":{"type":"string","format":"uuid"},"required":false,"name":"subjectId","in":"query"},{"schema":{"type":["array","null"],"items":{"type":"string","enum":["PENDING","ACTIVE","EXPIRED"]},"minItems":1,"maxItems":3},"required":false,"name":"recordedStatuses","in":"query"},{"schema":{"type":["array","null"],"items":{"type":"string","enum":["pending","current","expired","incomplete"]},"minItems":1,"maxItems":4},"required":false,"name":"effectiveStates","in":"query"},{"schema":{"type":"string","format":"date-time"},"required":false,"name":"expiresAtOrAfter","in":"query"},{"schema":{"type":"string","format":"date-time"},"required":false,"name":"expiresAtOrBefore","in":"query"},{"schema":{"type":"string","enum":["recorded","not_recorded","invalid_metadata"]},"required":false,"name":"evidenceRecordedState","in":"query"},{"schema":{"type":"string","enum":["true","false"]},"required":false,"name":"includePlaceholders","in":"query"},{"schema":{"type":"string","enum":["true","false"]},"required":false,"name":"includeArchived","in":"query"},{"schema":{"type":"string","pattern":"^\\d+$"},"required":false,"name":"limit","in":"query"},{"schema":{"type":"string","minLength":1,"maxLength":4096},"required":false,"name":"cursor","in":"query"},{"schema":{"type":["array","null"],"items":{"type":"string","enum":["current","expiring","expired","renewed","not_tracked"]},"minItems":1,"maxItems":5},"required":false,"name":"renewalStates","in":"query"},{"schema":{"type":"string","format":"uuid"},"required":false,"name":"createdById","in":"query"},{"schema":{"type":"string","format":"date-time"},"required":false,"name":"createdFrom","in":"query"},{"schema":{"type":"string","format":"date-time"},"required":false,"name":"createdTo","in":"query"}],"responses":{"200":{"description":"Stored certification record page.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"recordId":{"type":"string","format":"uuid"},"resourceKind":{"type":"string","enum":["stored_certification_record"]},"type":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"title":{"type":"string","minLength":1},"description":{"type":"string"},"enabled":{"type":"boolean"},"documentationRequired":{"type":"boolean"},"expiryNoticeDaysBefore":{"type":["integer","null"]},"subjectType":{"type":"string","enum":["supplier","customer","product","customer_address","warehouse","supplier_combination"]}},"required":["id","title","description","enabled","documentationRequired","expiryNoticeDaysBefore","subjectType"],"additionalProperties":false},"subject":{"type":"object","properties":{"subjectType":{"type":"string","enum":["supplier","customer","product","customer_address","warehouse","supplier_combination"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string","minLength":1},"externalId":{"type":["string","null"]},"archived":{"type":"boolean"},"customerId":{"type":["string","null"],"format":"uuid"},"locationId":{"type":["string","null"],"format":"uuid"},"addressId":{"type":["string","null"],"format":"uuid"},"combination":{"type":["object","null"],"properties":{"shipFromLocationId":{"type":"string","format":"uuid"},"shipFromLocationName":{"type":"string","minLength":1},"productId":{"type":"string","format":"uuid"},"productDisplayName":{"type":"string","minLength":1}},"required":["shipFromLocationId","shipFromLocationName","productId","productDisplayName"],"additionalProperties":false}},"required":["subjectType","id","displayName","externalId","archived","customerId","locationId","addressId","combination"],"additionalProperties":false},"recordedStatus":{"type":"string","enum":["PENDING","ACTIVE","EXPIRED"]},"effectiveState":{"type":"string","enum":["pending","current","expired","incomplete"]},"renewalState":{"type":"string","enum":["current","expiring","expired","renewed","not_tracked"]},"daysLeft":{"type":["integer","null"],"minimum":0},"validFrom":{"type":["string","null"],"format":"date-time"},"validTo":{"type":["string","null"],"format":"date-time"},"recordCompleteness":{"type":"string","enum":["populated","placeholder"]},"evidence":{"type":"object","properties":{"recordedState":{"type":"string","enum":["recorded","not_recorded","invalid_metadata"]},"fileName":{"type":["string","null"],"minLength":1}},"required":["recordedState","fileName"],"additionalProperties":false},"matchBasis":{"type":"array","items":{"type":"string","enum":["type_title","type_description","evidence_file_name","unfiltered"]},"minItems":1},"searchedFields":{"type":"array","items":{"type":"string","minLength":1}},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["user"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["system"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string","enum":["System User"]}},"required":["type","id","displayName"],"additionalProperties":false}]},"updatedAt":{"type":"string","format":"date-time"}},"required":["recordId","resourceKind","type","subject","recordedStatus","effectiveState","renewalState","daysLeft","validFrom","validTo","recordCompleteness","evidence","matchBasis","searchedFields","createdAt","createdBy","updatedAt"],"additionalProperties":false}},"meta":{"type":"object","properties":{"capabilityKey":{"type":"string","enum":["find_certification_records"]},"returnedRecords":{"type":"integer","minimum":0},"populationCount":{"type":["integer","null"],"minimum":0},"complete":{"type":"boolean"},"hasMore":{"type":"boolean"},"nextCursor":{"type":["string","null"]},"ordering":{"type":"string","enum":["title_id","valid_to_nulls_last_record_id","subject_type_subject_id_ship_from_product"]},"currentState":{"type":"boolean","enum":[true]},"snapshotIsolatedAcrossRequests":{"type":"boolean","enum":[false]},"requestId":{"type":"string"},"evaluatedAt":{"type":"string","format":"date-time"},"coverage":{"type":"object","properties":{"evaluatedAt":{"type":"string","format":"date-time"},"organizationId":{"type":"string","format":"uuid"},"organizationScoped":{"type":"boolean","enum":[true]},"currentState":{"type":"boolean","enum":[true]},"snapshotIsolatedAcrossRequests":{"type":"boolean","enum":[false]},"placeholderExcluded":{"type":"boolean"},"archivedExcluded":{"type":"boolean"},"searchedFields":{"type":"array","items":{"type":"string","minLength":1}},"requestedLanes":{"type":"array","items":{"type":"string","enum":["supplier","customer","product","customer_address","warehouse","supplier_combination"]}},"lanes":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"subjectType":{"type":"string","enum":["supplier","customer","product","customer_address","warehouse","supplier_combination"]},"status":{"type":"string","enum":["executed"]},"populationCount":{"type":["integer","null"],"minimum":0}},"required":["subjectType","status","populationCount"],"additionalProperties":false},{"type":"object","properties":{"subjectType":{"type":"string","enum":["supplier","customer","product","customer_address","warehouse","supplier_combination"]},"status":{"type":"string","enum":["denied"]}},"required":["subjectType","status"],"additionalProperties":false},{"type":"object","properties":{"subjectType":{"type":"string","enum":["supplier","customer","product","customer_address","warehouse","supplier_combination"]},"status":{"type":"string","enum":["unsupported"]}},"required":["subjectType","status"],"additionalProperties":false}]}},"appliedFilters":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","enum":["types"]},"subjectType":{"type":["string","null"],"enum":["supplier","customer","product","customer_address","warehouse","supplier_combination"]},"includeDisabled":{"type":"boolean"}},"required":["kind","subjectType","includeDisabled"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","enum":["records"]},"typeId":{"type":["string","null"],"format":"uuid"},"typeQuery":{"type":["string","null"],"minLength":1,"maxLength":120},"evidenceFileNameQuery":{"type":["string","null"],"minLength":1,"maxLength":240},"subjectTypes":{"type":["array","null"],"items":{"type":"string","enum":["supplier","customer","product","customer_address","warehouse","supplier_combination"]},"minItems":1,"maxItems":6},"subjectId":{"type":["string","null"],"format":"uuid"},"recordedStatuses":{"type":["array","null"],"items":{"type":"string","enum":["PENDING","ACTIVE","EXPIRED"]},"minItems":1,"maxItems":3},"effectiveStates":{"type":["array","null"],"items":{"type":"string","enum":["pending","current","expired","incomplete"]},"minItems":1,"maxItems":4},"expiresAtOrAfter":{"type":["string","null"],"format":"date-time"},"expiresAtOrBefore":{"type":["string","null"],"format":"date-time"},"evidenceRecordedState":{"type":["string","null"],"enum":["recorded","not_recorded","invalid_metadata"]},"includePlaceholders":{"type":"boolean"},"includeArchived":{"type":"boolean"},"renewalStates":{"type":["array","null"],"items":{"type":"string","enum":["current","expiring","expired","renewed","not_tracked"]},"minItems":1,"maxItems":5}},"required":["kind","typeId","typeQuery","evidenceFileNameQuery","subjectTypes","subjectId","recordedStatuses","effectiveStates","expiresAtOrAfter","expiresAtOrBefore","evidenceRecordedState","includePlaceholders","includeArchived","renewalStates"],"additionalProperties":false}]},"totalRecords":{"type":["integer","null"],"minimum":0},"returnedRecords":{"type":"integer","minimum":0}},"required":["evaluatedAt","organizationId","organizationScoped","currentState","snapshotIsolatedAcrossRequests","placeholderExcluded","archivedExcluded","searchedFields","requestedLanes","lanes","appliedFilters","totalRecords","returnedRecords"],"additionalProperties":false},"capabilityVersion":{"type":"string","enum":["1.2.0"]}},"required":["capabilityKey","returnedRecords","populationCount","complete","hasMore","nextCursor","ordering","currentState","snapshotIsolatedAcrossRequests","requestId","evaluatedAt","coverage","capabilityVersion"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/certification-subjects":{"get":{"operationId":"findPublicAPICertificationSubjects","summary":"Find subjects with matching certification records","description":"Returns deduplicated authorized subjects with exact matching-record counts. Warehouse subjects also require warehouses:read. It reports records stored in ShelfCycle, not external certification or compliance truth. Current records and non-placeholder rows are the default.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"certifications:read","parameters":[{"schema":{"type":"string","format":"uuid"},"required":false,"name":"typeId","in":"query"},{"schema":{"type":"string","minLength":1},"required":false,"name":"typeQuery","in":"query"},{"schema":{"type":"string","minLength":1},"required":false,"name":"evidenceFileNameQuery","in":"query"},{"schema":{"type":["array","null"],"items":{"type":"string","enum":["supplier","customer","product","customer_address","warehouse","supplier_combination"]},"minItems":1,"maxItems":6},"required":false,"name":"subjectTypes","in":"query"},{"schema":{"type":"string","format":"uuid"},"required":false,"name":"subjectId","in":"query"},{"schema":{"type":["array","null"],"items":{"type":"string","enum":["PENDING","ACTIVE","EXPIRED"]},"minItems":1,"maxItems":3},"required":false,"name":"recordedStatuses","in":"query"},{"schema":{"type":["array","null"],"items":{"type":"string","enum":["pending","current","expired","incomplete"]},"minItems":1,"maxItems":4},"required":false,"name":"effectiveStates","in":"query"},{"schema":{"type":"string","format":"date-time"},"required":false,"name":"expiresAtOrAfter","in":"query"},{"schema":{"type":"string","format":"date-time"},"required":false,"name":"expiresAtOrBefore","in":"query"},{"schema":{"type":"string","enum":["recorded","not_recorded","invalid_metadata"]},"required":false,"name":"evidenceRecordedState","in":"query"},{"schema":{"type":"string","enum":["true","false"]},"required":false,"name":"includePlaceholders","in":"query"},{"schema":{"type":"string","enum":["true","false"]},"required":false,"name":"includeArchived","in":"query"},{"schema":{"type":"string","pattern":"^\\d+$"},"required":false,"name":"limit","in":"query"},{"schema":{"type":"string","minLength":1,"maxLength":4096},"required":false,"name":"cursor","in":"query"}],"responses":{"200":{"description":"Certification subject page.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"subjectType":{"type":"string","enum":["supplier","customer","product","customer_address","warehouse","supplier_combination"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string","minLength":1},"externalId":{"type":["string","null"]},"archived":{"type":"boolean"},"customerId":{"type":["string","null"],"format":"uuid"},"locationId":{"type":["string","null"],"format":"uuid"},"addressId":{"type":["string","null"],"format":"uuid"},"combination":{"type":["object","null"],"properties":{"shipFromLocationId":{"type":"string","format":"uuid"},"shipFromLocationName":{"type":"string","minLength":1},"productId":{"type":"string","format":"uuid"},"productDisplayName":{"type":"string","minLength":1}},"required":["shipFromLocationId","shipFromLocationName","productId","productDisplayName"],"additionalProperties":false},"matchingRecordCount":{"type":"integer","exclusiveMinimum":0},"currentMatchingRecordCount":{"type":"integer","minimum":0},"latestCurrentValidTo":{"type":["string","null"],"format":"date-time"},"type":{"type":"string","enum":["certification_subject"]}},"required":["subjectType","id","displayName","externalId","archived","customerId","locationId","addressId","combination","matchingRecordCount","currentMatchingRecordCount","latestCurrentValidTo","type"],"additionalProperties":false}},"meta":{"type":"object","properties":{"capabilityKey":{"type":"string","enum":["find_certification_subjects"]},"returnedRecords":{"type":"integer","minimum":0},"populationCount":{"type":["integer","null"],"minimum":0},"complete":{"type":"boolean"},"hasMore":{"type":"boolean"},"nextCursor":{"type":["string","null"]},"ordering":{"type":"string","enum":["title_id","valid_to_nulls_last_record_id","subject_type_subject_id_ship_from_product"]},"currentState":{"type":"boolean","enum":[true]},"snapshotIsolatedAcrossRequests":{"type":"boolean","enum":[false]},"requestId":{"type":"string"},"evaluatedAt":{"type":"string","format":"date-time"},"coverage":{"type":"object","properties":{"evaluatedAt":{"type":"string","format":"date-time"},"organizationId":{"type":"string","format":"uuid"},"organizationScoped":{"type":"boolean","enum":[true]},"currentState":{"type":"boolean","enum":[true]},"snapshotIsolatedAcrossRequests":{"type":"boolean","enum":[false]},"placeholderExcluded":{"type":"boolean"},"archivedExcluded":{"type":"boolean"},"searchedFields":{"type":"array","items":{"type":"string","minLength":1}},"requestedLanes":{"type":"array","items":{"type":"string","enum":["supplier","customer","product","customer_address","warehouse","supplier_combination"]}},"lanes":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"subjectType":{"type":"string","enum":["supplier","customer","product","customer_address","warehouse","supplier_combination"]},"status":{"type":"string","enum":["executed"]},"populationCount":{"type":["integer","null"],"minimum":0}},"required":["subjectType","status","populationCount"],"additionalProperties":false},{"type":"object","properties":{"subjectType":{"type":"string","enum":["supplier","customer","product","customer_address","warehouse","supplier_combination"]},"status":{"type":"string","enum":["denied"]}},"required":["subjectType","status"],"additionalProperties":false},{"type":"object","properties":{"subjectType":{"type":"string","enum":["supplier","customer","product","customer_address","warehouse","supplier_combination"]},"status":{"type":"string","enum":["unsupported"]}},"required":["subjectType","status"],"additionalProperties":false}]}},"appliedFilters":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","enum":["types"]},"subjectType":{"type":["string","null"],"enum":["supplier","customer","product","customer_address","warehouse","supplier_combination"]},"includeDisabled":{"type":"boolean"}},"required":["kind","subjectType","includeDisabled"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","enum":["records"]},"typeId":{"type":["string","null"],"format":"uuid"},"typeQuery":{"type":["string","null"],"minLength":1,"maxLength":120},"evidenceFileNameQuery":{"type":["string","null"],"minLength":1,"maxLength":240},"subjectTypes":{"type":["array","null"],"items":{"type":"string","enum":["supplier","customer","product","customer_address","warehouse","supplier_combination"]},"minItems":1,"maxItems":6},"subjectId":{"type":["string","null"],"format":"uuid"},"recordedStatuses":{"type":["array","null"],"items":{"type":"string","enum":["PENDING","ACTIVE","EXPIRED"]},"minItems":1,"maxItems":3},"effectiveStates":{"type":["array","null"],"items":{"type":"string","enum":["pending","current","expired","incomplete"]},"minItems":1,"maxItems":4},"expiresAtOrAfter":{"type":["string","null"],"format":"date-time"},"expiresAtOrBefore":{"type":["string","null"],"format":"date-time"},"evidenceRecordedState":{"type":["string","null"],"enum":["recorded","not_recorded","invalid_metadata"]},"includePlaceholders":{"type":"boolean"},"includeArchived":{"type":"boolean"},"renewalStates":{"type":["array","null"],"items":{"type":"string","enum":["current","expiring","expired","renewed","not_tracked"]},"minItems":1,"maxItems":5}},"required":["kind","typeId","typeQuery","evidenceFileNameQuery","subjectTypes","subjectId","recordedStatuses","effectiveStates","expiresAtOrAfter","expiresAtOrBefore","evidenceRecordedState","includePlaceholders","includeArchived","renewalStates"],"additionalProperties":false}]},"totalRecords":{"type":["integer","null"],"minimum":0},"returnedRecords":{"type":"integer","minimum":0}},"required":["evaluatedAt","organizationId","organizationScoped","currentState","snapshotIsolatedAcrossRequests","placeholderExcluded","archivedExcluded","searchedFields","requestedLanes","lanes","appliedFilters","totalRecords","returnedRecords"],"additionalProperties":false},"capabilityVersion":{"type":"string","enum":["1.1.0"]}},"required":["capabilityKey","returnedRecords","populationCount","complete","hasMore","nextCursor","ordering","currentState","snapshotIsolatedAcrossRequests","requestId","evaluatedAt","coverage","capabilityVersion"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/certification-records/{recordId}":{"get":{"operationId":"getPublicAPICertificationRecord","summary":"Get one stored certification record","description":"Returns one authorized stored certification row and metadata-only evidence recordedState and fileName. A warehouse record also requires warehouses:read. Hidden, foreign, deleted, and missing records are indistinguishable.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"certifications:read","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"recordId","in":"path"}],"responses":{"200":{"description":"Stored certification record detail.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"recordId":{"type":"string","format":"uuid"},"resourceKind":{"type":"string","enum":["stored_certification_record"]},"type":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"title":{"type":"string","minLength":1},"description":{"type":"string"},"enabled":{"type":"boolean"},"documentationRequired":{"type":"boolean"},"expiryNoticeDaysBefore":{"type":["integer","null"]},"subjectType":{"type":"string","enum":["supplier","customer","product","customer_address","warehouse","supplier_combination"]}},"required":["id","title","description","enabled","documentationRequired","expiryNoticeDaysBefore","subjectType"],"additionalProperties":false},"subject":{"type":"object","properties":{"subjectType":{"type":"string","enum":["supplier","customer","product","customer_address","warehouse","supplier_combination"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string","minLength":1},"externalId":{"type":["string","null"]},"archived":{"type":"boolean"},"customerId":{"type":["string","null"],"format":"uuid"},"locationId":{"type":["string","null"],"format":"uuid"},"addressId":{"type":["string","null"],"format":"uuid"},"combination":{"type":["object","null"],"properties":{"shipFromLocationId":{"type":"string","format":"uuid"},"shipFromLocationName":{"type":"string","minLength":1},"productId":{"type":"string","format":"uuid"},"productDisplayName":{"type":"string","minLength":1}},"required":["shipFromLocationId","shipFromLocationName","productId","productDisplayName"],"additionalProperties":false}},"required":["subjectType","id","displayName","externalId","archived","customerId","locationId","addressId","combination"],"additionalProperties":false},"recordedStatus":{"type":"string","enum":["PENDING","ACTIVE","EXPIRED"]},"effectiveState":{"type":"string","enum":["pending","current","expired","incomplete"]},"renewalState":{"type":"string","enum":["current","expiring","expired","renewed","not_tracked"]},"daysLeft":{"type":["integer","null"],"minimum":0},"validFrom":{"type":["string","null"],"format":"date-time"},"validTo":{"type":["string","null"],"format":"date-time"},"recordCompleteness":{"type":"string","enum":["populated","placeholder"]},"evidence":{"type":"object","properties":{"recordedState":{"type":"string","enum":["recorded","not_recorded","invalid_metadata"]},"fileName":{"type":["string","null"],"minLength":1}},"required":["recordedState","fileName"],"additionalProperties":false},"matchBasis":{"type":"array","items":{"type":"string","enum":["type_title","type_description","evidence_file_name","unfiltered"]},"minItems":1},"searchedFields":{"type":"array","items":{"type":"string","minLength":1}},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["user"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["system"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string","enum":["System User"]}},"required":["type","id","displayName"],"additionalProperties":false}]},"updatedAt":{"type":"string","format":"date-time"}},"required":["recordId","resourceKind","type","subject","recordedStatus","effectiveState","renewalState","daysLeft","validFrom","validTo","recordCompleteness","evidence","matchBasis","searchedFields","createdAt","createdBy","updatedAt"],"additionalProperties":false},"meta":{"type":"object","properties":{"capabilityKey":{"type":"string","enum":["get_certification_record"]},"capabilityVersion":{"type":"string","enum":["1.2.0"]},"evaluatedAt":{"type":"string","format":"date-time"},"currentState":{"type":"boolean","enum":[true]},"snapshotIsolatedAcrossRequests":{"type":"boolean","enum":[false]},"requestId":{"type":"string"}},"required":["capabilityKey","capabilityVersion","evaluatedAt","currentState","snapshotIsolatedAcrossRequests","requestId"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/purchase-orders/{id}/documents":{"get":{"operationId":"listPublicAPIPurchaseOrderDocuments","summary":"List purchase-order documents","description":"Returns all attached documents attached to one visible purchase order. ShelfCycle bucket files use short-lived signed read URLs.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"purchase-order-execution:read","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Purchase-order documents.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"documents":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["document"]},"id":{"type":"string","format":"uuid"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"urlClass":{"type":"string","enum":["shelfcycle","external"]},"access":{"type":"object","properties":{"mode":{"type":"string","enum":["signed","raw","unavailable"]},"url":{"type":"string"},"expiresAt":{"type":"string","format":"date-time"}},"required":["mode"],"additionalProperties":false}},"required":["type","id","fileName","createdAt","urlClass","access"],"additionalProperties":false}},"truncated":{"type":"boolean"}},"required":["documents","truncated"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}},"post":{"operationId":"createPublicAPIPurchaseOrderDocument","summary":"Attach a purchase-order document","description":"Creates an attached document on a visible purchase order. Execute requests require Idempotency-Key. dryRun=true may omit Idempotency-Key and returns a blocked readiness check instead of writing. This creates one Document row and one idempotency identity. It does not transport binary files through the application, mutate the purchase order, receive inventory, or post AP or GL entries. A valid API-upload descriptor may be passed between keys in the same organization. documents:upload is required only to mint the grant; association and SDS routes require their documented target write scope and current ShelfCycle access. Descriptor possession grants no read access. API-upload association create and replay responses omit signed access unless the calling key also has the target read scope and live view permission.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"purchase-order-documents:write","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","enum":["true"]},"required":false,"name":"dryRun","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Required for execute requests. dryRun=true may omit this header and receive an idempotency_key_required check."},"required":false,"description":"Required for execute requests. dryRun=true may omit this header and receive an idempotency_key_required check.","name":"Idempotency-Key","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"fileName":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[^\\u0000-\\u001F\\u007F]*$"},"url":{"type":"string","minLength":1,"maxLength":2048}},"required":["fileName","url"],"additionalProperties":false}}}},"responses":{"200":{"description":"Idempotent replay returned the existing purchase-order document, or dryRun returned write readiness.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["document"]},"id":{"type":"string","format":"uuid"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"urlClass":{"type":"string","enum":["shelfcycle","external"]},"access":{"type":"object","properties":{"mode":{"type":"string","enum":["signed","raw","unavailable"]},"url":{"type":"string"},"expiresAt":{"type":"string","format":"date-time"}},"required":["mode"],"additionalProperties":false},"idempotencyStatus":{"type":"string","enum":["created","replayed"]},"integrity":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","enum":["verified"]},"checksumSha256":{"type":"string","pattern":"^[a-f0-9]{64}$","description":"Lowercase SHA-256 matched by the association-time storage HEAD check."},"sizeBytes":{"type":"integer","exclusiveMinimum":0,"description":"Storage-reported object size verified at association time."},"contentType":{"type":"string","minLength":1,"description":"Storage-reported canonical content type verified at association time."},"verifiedAt":{"type":"string","format":"date-time","description":"Time ShelfCycle completed the association verification."}},"required":["status","checksumSha256","sizeBytes","contentType","verifiedAt"],"additionalProperties":false,"description":"Durable association receipt; it is not malware scanning, content interpretation, or perpetual-retention proof."},{"type":"object","properties":{"status":{"type":"string","enum":["not_verified"]},"reason":{"type":"string","enum":["external_or_legacy_link"]}},"required":["status","reason"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","enum":["unavailable"]},"reason":{"type":"string","enum":["legacy_receipt_not_recorded"]}},"required":["status","reason"],"additionalProperties":false}]}},"required":["type","id","fileName","createdAt","urlClass","access","idempotencyStatus","integrity"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["write_readiness"]},"operation":{"type":"string","enum":["warehouses.create","warehouses.update","warehouses.archive","warehouses.unarchive","shipping_options.create","shipping_options.update","shipping_options.archive","shipping_options.unarchive","reorder_points.create","tags.create","tags.update","tag_assignments.create","tag_assignments.delete","notes.create","notes.update","opportunities.create","opportunities.update","opportunities.close","opportunities.meta-upsert","contacts.create","contacts.update","customers.create","customers.update","customer_locations.create","customer_locations.update","customer_addresses.create","customer_addresses.update","suppliers.create","suppliers.update","supplier_ship_from_locations.create","supplier_ship_from_locations.update","products.create","products.update","products.archive","products.unarchive","product_packaging.create","products.suppliers.create","products.suppliers.delete","products.aliases.create","products.aliases.update","products.aliases.delete","product_families.aliases.create","product_families.aliases.update","product_families.aliases.delete","products.customer_part_numbers.create","products.customer_part_numbers.update","products.customer_part_numbers.delete","product_sds.update","product_documents.create","customer_documents.create","supplier_documents.create","purchase_order_documents.create","product_families.create","product_families.update","cost_book_entries.create","current_cost_sources.put","customers.archive","customers.unarchive","suppliers.archive","suppliers.unarchive","contacts.archive","contacts.unarchive","customer_addresses.archive","customer_addresses.unarchive","supplier_ship_from_locations.archive","supplier_ship_from_locations.unarchive","representatives.create","representatives.update","representatives.archive","representatives.unarchive","payment_terms.create","payment_terms.update","ledger_accounts.create","ledger_accounts.update"]},"status":{"type":"string","enum":["ready","blocked"]},"wouldWrite":{"type":"boolean","enum":[false]},"submit":{"type":"object","properties":{"method":{"type":"string","enum":["POST","PATCH","PUT","DELETE"]},"path":{"type":"string"},"query":{"type":"object","properties":{},"additionalProperties":false}},"required":["method","path","query"],"additionalProperties":false},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false},"checks":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["not_direct_ship","address_role_required","address_role_valid","already_assigned","already_exists","active_duplicate","ambiguous_external_id","ambiguous_natural_key","api_created","archived_target","archived_record","archive_blocked","account_type_locked","duplicate_candidate_found","duplicate_candidate_overflow","duplicate_check_clear","duplicate_check_not_needed","duplicate_contact","duplicate_customer","duplicate_customer_address","duplicate_customer_location","duplicate_note","duplicate_resolution_applied","duplicate_supplier","duplicate_supplier_ship_from_location","document_url_org_scoped","document_url_valid","upload_verified","sds_converged","idempotency_available","idempotency_key_required","idempotency_key_reused","idempotency_replay","idempotency_target_missing","income_statement_type_invalid","hard_identity_clear","nested_external_id_clear","commercial_references_valid","credit_denomination_mismatch","customer_service_representative_reference_active","ledger_account_reference_valid","payment_terms_reference_exists","sales_person_reference_active","supplier_representative_reference_active","duplicate_reference_identity","external_id_conflict","if_match_current","base_uom_transition_allowed","base_uom_transition_blocked","attribute_assignments_valid","attribute_assignments_invalid","selected_supplier_link","linked_records_available","natural_key_conflict","not_api_created","no_downstream_mutation","order_sensitive_update_allowed","order_sensitive_update_blocked","parent_available","cost_book_entry_blocked","cost_book_entry_valid","cost_book_reference_not_visible","unsupported_cost_book_uom","cost_uom_conversion_unavailable","cost_book_base_unavailable","cost_book_base_ambiguous","cost_ship_from_location_not_visible","cost_package_quantity_invalid","cost_component_invalid","cost_date_window_invalid","cost_date_overlap","cost_amount_overflow","cost_book_conflict","product_family_reference_active","product_packaging_reference_active","primary_child_available","primary_change_unsupported","reference_visibility_blocked","scope_authorized","stale_record","stale_cost_book_entry","supplier_reference_active","tag_applicable","tag_available","tag_exists","tag_found","tag_not_applicable","tag_not_found","type_immutable","type_known","type_required","target_active","target_available","target_not_found_or_not_visible","targets_visible","unsupported_linked_record","unsupported_profile_shape","variable_qty_valid","validation_failed","value_nonempty"]},"status":{"type":"string","enum":["passed","blocked"]},"message":{"type":"string"},"param":{"type":"string"}},"required":["code","status","message"],"additionalProperties":false}},"duplicateCandidates":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact","customer","supplier","customer_location","customer_address","supplier_ship_from_location","product","product_family","document"]},"readable":{"type":"boolean"},"version":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","product","purchase_order"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"matchReasons":{"type":"array","items":{"type":"string","enum":["name","email","externalId","address","code","product","url"]}},"readbackPath":{"type":"string"}},"required":["type","readable","matchReasons"],"additionalProperties":false}},"idempotency":{"type":"object","properties":{"required":{"type":"boolean"},"keyProvided":{"type":"boolean"},"wouldReplay":{"type":"boolean"}},"required":["required","keyProvided","wouldReplay"],"additionalProperties":false},"wouldChange":{"type":"object","properties":{"fieldNames":{"type":"array","items":{"type":"string"}},"values":{"type":"object","additionalProperties":{}}},"required":["fieldNames","values"],"additionalProperties":false},"impactAnalysis":{"type":"object","additionalProperties":{}},"requestId":{"type":"string"}},"required":["type","operation","status","wouldWrite","submit","verification","checks","duplicateCandidates","requestId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}]},"examples":{"verified-api-upload-replay":{"summary":"Exact replay returns the stored association receipt without another storage check","value":{"data":{"type":"document","id":"11111111-1111-4111-8111-111111111111","fileName":"Supplier Confirmation.pdf","createdAt":"2026-08-11T12:00:00.000Z","urlClass":"shelfcycle","access":{"mode":"unavailable"},"idempotencyStatus":"replayed","integrity":{"status":"verified","checksumSha256":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","sizeBytes":4096,"contentType":"application/pdf","verifiedAt":"2026-08-11T12:00:00.000Z"}}}}}}}},"201":{"description":"Purchase-order document created.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["document"]},"id":{"type":"string","format":"uuid"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"urlClass":{"type":"string","enum":["shelfcycle","external"]},"access":{"type":"object","properties":{"mode":{"type":"string","enum":["signed","raw","unavailable"]},"url":{"type":"string"},"expiresAt":{"type":"string","format":"date-time"}},"required":["mode"],"additionalProperties":false},"idempotencyStatus":{"type":"string","enum":["created","replayed"]},"integrity":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","enum":["verified"]},"checksumSha256":{"type":"string","pattern":"^[a-f0-9]{64}$","description":"Lowercase SHA-256 matched by the association-time storage HEAD check."},"sizeBytes":{"type":"integer","exclusiveMinimum":0,"description":"Storage-reported object size verified at association time."},"contentType":{"type":"string","minLength":1,"description":"Storage-reported canonical content type verified at association time."},"verifiedAt":{"type":"string","format":"date-time","description":"Time ShelfCycle completed the association verification."}},"required":["status","checksumSha256","sizeBytes","contentType","verifiedAt"],"additionalProperties":false,"description":"Durable association receipt; it is not malware scanning, content interpretation, or perpetual-retention proof."},{"type":"object","properties":{"status":{"type":"string","enum":["not_verified"]},"reason":{"type":"string","enum":["external_or_legacy_link"]}},"required":["status","reason"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","enum":["unavailable"]},"reason":{"type":"string","enum":["legacy_receipt_not_recorded"]}},"required":["status","reason"],"additionalProperties":false}]}},"required":["type","id","fileName","createdAt","urlClass","access","idempotencyStatus","integrity"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},"examples":{"verified-api-upload":{"summary":"API-upload association with a durable integrity receipt","value":{"data":{"type":"document","id":"11111111-1111-4111-8111-111111111111","fileName":"Supplier Confirmation.pdf","createdAt":"2026-08-11T12:00:00.000Z","urlClass":"shelfcycle","access":{"mode":"unavailable"},"idempotencyStatus":"created","integrity":{"status":"verified","checksumSha256":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","sizeBytes":4096,"contentType":"application/pdf","verifiedAt":"2026-08-11T12:00:00.000Z"}}}}}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested parent or record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"409":{"description":"The write conflicted with an existing record, idempotency payload, or stale If-Match value.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/products/{id}/current-cost-source":{"get":{"operationId":"getPublicAPICurrentCostSource","summary":"Get product Current Source authority","description":"Returns the product's exact cost-source authority, eligible Cost Book supplier lanes, and selection provenance. Fixed-supplier products remain authoritative to their fixed supplier. Variable-supplier products return a persisted Current Source when configured; an unavailable persisted source fails closed and is never silently replaced by another lane.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"current-cost-sources:read","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Current Source authority and eligible lanes.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"authorityState":{"type":"string","enum":["fixed_supplier","current_source","unconfigured","unavailable"]},"authoritativeLane":{"type":["object","null"],"properties":{"productId":{"type":"string","format":"uuid"},"supplierId":{"type":"string","format":"uuid"},"supplierName":{"type":"string"},"shipFromLocationId":{"type":["string","null"],"format":"uuid"},"shipFromLocationName":{"type":["string","null"]},"evidenceSource":{"type":["string","null"],"enum":["active_book","construction"]}},"required":["productId","supplierId","supplierName","shipFromLocationId","shipFromLocationName","evidenceSource"],"additionalProperties":false},"inferredDisplay":{"type":["object","null"],"properties":{"lane":{"type":"object","properties":{"productId":{"type":"string","format":"uuid"},"supplierId":{"type":"string","format":"uuid"},"supplierName":{"type":"string"},"shipFromLocationId":{"type":["string","null"],"format":"uuid"},"shipFromLocationName":{"type":["string","null"]},"costPerBaseUomCents":{"type":["number","null"]},"uom":{"type":["string","null"]},"dateFrom":{"type":"string","format":"date-time"},"evidenceSource":{"type":"string","enum":["active_book","construction"]}},"required":["productId","supplierId","supplierName","shipFromLocationId","shipFromLocationName","costPerBaseUomCents","uom","dateFrom","evidenceSource"],"additionalProperties":false},"selectionReason":{"type":"string","enum":["only_available","most_recent"]},"evidenceSource":{"type":"string","enum":["active_book","construction"]}},"required":["lane","selectionReason","evidenceSource"],"additionalProperties":false},"candidates":{"type":"array","items":{"type":"object","properties":{"productId":{"type":"string","format":"uuid"},"supplierId":{"type":"string","format":"uuid"},"supplierName":{"type":"string"},"shipFromLocationId":{"type":["string","null"],"format":"uuid"},"shipFromLocationName":{"type":["string","null"]},"costPerBaseUomCents":{"type":["number","null"]},"uom":{"type":["string","null"]},"dateFrom":{"type":"string","format":"date-time"},"evidenceSource":{"type":"string","enum":["active_book","construction"]}},"required":["productId","supplierId","supplierName","shipFromLocationId","shipFromLocationName","costPerBaseUomCents","uom","dateFrom","evidenceSource"],"additionalProperties":false}},"locationCandidates":{"type":"array","items":{"type":"object","properties":{"productId":{"type":"string","format":"uuid"},"supplierId":{"type":"string","format":"uuid"},"supplierName":{"type":"string"},"shipFromLocationId":{"type":["string","null"],"format":"uuid"},"shipFromLocationName":{"type":["string","null"]},"costPerBaseUomCents":{"type":["number","null"]},"uom":{"type":["string","null"]},"dateFrom":{"type":"string","format":"date-time"},"evidenceSource":{"type":"string","enum":["active_book","construction"]}},"required":["productId","supplierId","supplierName","shipFromLocationId","shipFromLocationName","costPerBaseUomCents","uom","dateFrom","evidenceSource"],"additionalProperties":false}},"candidateCount":{"type":"integer","minimum":0},"supplierCandidateCount":{"type":"integer","minimum":0},"selectionProvenance":{"type":["object","null"],"properties":{"selectedAt":{"type":"string","format":"date-time"},"selectedById":{"type":"string","format":"uuid"},"selectedByName":{"type":"string"}},"required":["selectedAt","selectedById","selectedByName"],"additionalProperties":false},"unavailableSupplierId":{"type":["string","null"],"format":"uuid"},"unavailableSupplierName":{"type":["string","null"]},"unavailableShipFromLocationId":{"type":["string","null"],"format":"uuid"},"unavailableShipFromLocationName":{"type":["string","null"]},"unavailabilityReason":{"type":["string","null"]}},"required":["authorityState","authoritativeLane","inferredDisplay","candidates","locationCandidates","candidateCount","supplierCandidateCount","selectionProvenance","unavailableSupplierId","unavailableSupplierName","unavailableShipFromLocationId","unavailableShipFromLocationName","unavailabilityReason"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}},"put":{"operationId":"putPublicAPICurrentCostSource","summary":"Set, replace, or clear product Current Source authority","description":"Sets, replaces, or clears the Current Source for a variable-supplier product. expectedCurrentSupplierId is required in the strict body and provides optimistic concurrency; a true no-op succeeds before stale-state rejection. dryRun=true returns eligibility and consequence without writing. Execute records API actor and organization provenance.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"current-cost-sources:write","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","enum":["true"]},"required":false,"name":"dryRun","in":"query"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"supplierId":{"type":["string","null"],"format":"uuid"},"shipFromLocationId":{"type":["string","null"],"format":"uuid"},"expectedCurrentSupplierId":{"type":["string","null"],"format":"uuid"},"expectedCurrentShipFromLocationId":{"type":["string","null"],"format":"uuid"}},"required":["supplierId","expectedCurrentSupplierId"],"additionalProperties":false}}}},"responses":{"200":{"description":"Current Source write receipt, or dryRun eligibility and consequence.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"data":{"type":"object","properties":{"status":{"type":"string","enum":["updated","unchanged"]},"dryRun":{"type":"boolean","enum":[false]},"outcome":{"type":"string","enum":["set","replace","clear","unchanged"]},"previousSupplierId":{"type":["string","null"],"format":"uuid"},"previousShipFromLocationId":{"type":["string","null"],"format":"uuid"},"current":{"type":"object","properties":{"authorityState":{"type":"string","enum":["fixed_supplier","current_source","unconfigured","unavailable"]},"authoritativeLane":{"type":["object","null"],"properties":{"productId":{"type":"string","format":"uuid"},"supplierId":{"type":"string","format":"uuid"},"supplierName":{"type":"string"},"shipFromLocationId":{"type":["string","null"],"format":"uuid"},"shipFromLocationName":{"type":["string","null"]},"evidenceSource":{"type":["string","null"],"enum":["active_book","construction"]}},"required":["productId","supplierId","supplierName","shipFromLocationId","shipFromLocationName","evidenceSource"],"additionalProperties":false},"inferredDisplay":{"type":["object","null"],"properties":{"lane":{"type":"object","properties":{"productId":{"type":"string","format":"uuid"},"supplierId":{"type":"string","format":"uuid"},"supplierName":{"type":"string"},"shipFromLocationId":{"type":["string","null"],"format":"uuid"},"shipFromLocationName":{"type":["string","null"]},"costPerBaseUomCents":{"type":["number","null"]},"uom":{"type":["string","null"]},"dateFrom":{"type":"string","format":"date-time"},"evidenceSource":{"type":"string","enum":["active_book","construction"]}},"required":["productId","supplierId","supplierName","shipFromLocationId","shipFromLocationName","costPerBaseUomCents","uom","dateFrom","evidenceSource"],"additionalProperties":false},"selectionReason":{"type":"string","enum":["only_available","most_recent"]},"evidenceSource":{"type":"string","enum":["active_book","construction"]}},"required":["lane","selectionReason","evidenceSource"],"additionalProperties":false},"candidates":{"type":"array","items":{"type":"object","properties":{"productId":{"type":"string","format":"uuid"},"supplierId":{"type":"string","format":"uuid"},"supplierName":{"type":"string"},"shipFromLocationId":{"type":["string","null"],"format":"uuid"},"shipFromLocationName":{"type":["string","null"]},"costPerBaseUomCents":{"type":["number","null"]},"uom":{"type":["string","null"]},"dateFrom":{"type":"string","format":"date-time"},"evidenceSource":{"type":"string","enum":["active_book","construction"]}},"required":["productId","supplierId","supplierName","shipFromLocationId","shipFromLocationName","costPerBaseUomCents","uom","dateFrom","evidenceSource"],"additionalProperties":false}},"locationCandidates":{"type":"array","items":{"type":"object","properties":{"productId":{"type":"string","format":"uuid"},"supplierId":{"type":"string","format":"uuid"},"supplierName":{"type":"string"},"shipFromLocationId":{"type":["string","null"],"format":"uuid"},"shipFromLocationName":{"type":["string","null"]},"costPerBaseUomCents":{"type":["number","null"]},"uom":{"type":["string","null"]},"dateFrom":{"type":"string","format":"date-time"},"evidenceSource":{"type":"string","enum":["active_book","construction"]}},"required":["productId","supplierId","supplierName","shipFromLocationId","shipFromLocationName","costPerBaseUomCents","uom","dateFrom","evidenceSource"],"additionalProperties":false}},"candidateCount":{"type":"integer","minimum":0},"supplierCandidateCount":{"type":"integer","minimum":0},"selectionProvenance":{"type":["object","null"],"properties":{"selectedAt":{"type":"string","format":"date-time"},"selectedById":{"type":"string","format":"uuid"},"selectedByName":{"type":"string"}},"required":["selectedAt","selectedById","selectedByName"],"additionalProperties":false},"unavailableSupplierId":{"type":["string","null"],"format":"uuid"},"unavailableSupplierName":{"type":["string","null"]},"unavailableShipFromLocationId":{"type":["string","null"],"format":"uuid"},"unavailableShipFromLocationName":{"type":["string","null"]},"unavailabilityReason":{"type":["string","null"]}},"required":["authorityState","authoritativeLane","inferredDisplay","candidates","locationCandidates","candidateCount","supplierCandidateCount","selectionProvenance","unavailableSupplierId","unavailableSupplierName","unavailableShipFromLocationId","unavailableShipFromLocationName","unavailabilityReason"],"additionalProperties":false},"provenance":{"type":["object","null"],"properties":{"selectedAt":{"type":"string","format":"date-time"},"selectedById":{"type":"string","format":"uuid"},"selectedByName":{"type":"string"}},"required":["selectedAt","selectedById","selectedByName"],"additionalProperties":false},"verification":{"type":"object","properties":{"method":{"type":"string","enum":["GET"]},"path":{"type":"string"}},"required":["method","path"],"additionalProperties":false}},"required":["status","dryRun","outcome","previousSupplierId","previousShipFromLocationId","current","provenance","verification"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"status":{"type":"string","enum":["ready"]},"operation":{"type":"string","enum":["current_cost_sources.put"]},"dryRun":{"type":"boolean","enum":[true]},"desiredSupplierId":{"type":["string","null"],"format":"uuid"},"desiredShipFromLocationId":{"type":["string","null"],"format":"uuid"},"previousSupplierId":{"type":["string","null"],"format":"uuid"},"previousShipFromLocationId":{"type":["string","null"],"format":"uuid"},"consequence":{"type":"string","enum":["set","replace","clear","unchanged"]},"eligibility":{"type":"object","properties":{"ready":{"type":"boolean","enum":[true]},"candidateCount":{"type":"integer","minimum":0}},"required":["ready","candidateCount"],"additionalProperties":false},"verification":{"type":"object","properties":{"method":{"type":"string","enum":["GET"]},"path":{"type":"string"}},"required":["method","path"],"additionalProperties":false}},"required":["status","operation","dryRun","desiredSupplierId","desiredShipFromLocationId","previousSupplierId","previousShipFromLocationId","consequence","eligibility","verification"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}]}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested parent or record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"409":{"description":"Current Source changed after it was read. Re-read authority and retry with the returned expected supplier.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["conflict"]},"code":{"type":"string","enum":["stale_current_cost_source"]},"message":{"type":"string"},"retryable":{"type":"boolean","enum":[true]},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","properties":{"expectedCurrentSupplierId":{"type":["string","null"],"format":"uuid"},"expectedCurrentShipFromLocationId":{"type":["string","null"],"format":"uuid"}},"required":["expectedCurrentSupplierId","expectedCurrentShipFromLocationId"],"additionalProperties":false},"readPath":{"type":"string","enum":["/api/v1/products/{id}/current-cost-source"]}},"required":["rule","expected","readPath"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","retryable","repairContext","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false},"examples":{"stale-current-source":{"summary":"The selected supplier changed after the caller read it","value":{"error":{"type":"conflict","code":"stale_current_cost_source","message":"Current Source changed after it was read.","retryable":true,"repairContext":{"rule":"expectedCurrentSupplierId and expectedCurrentShipFromLocationId must match the current selected supplier and ship-from location before a non-noop change.","expected":{"expectedCurrentSupplierId":"22222222-2222-4222-8222-222222222222","expectedCurrentShipFromLocationId":null},"readPath":"/api/v1/products/{id}/current-cost-source"},"requestId":"req-current-source-stale"}}}}}}},"422":{"description":"The product or requested supplier lane cannot accept this Current Source change.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["conflict","validation_error"]},"code":{"type":"string","enum":["current_cost_source_unavailable"]},"message":{"type":"string"},"param":{"type":"string","enum":["supplierId"]},"retryable":{"type":"boolean","enum":[false]},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false},{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}]},"examples":{"unavailable-current-source":{"summary":"The requested supplier lane is not eligible","value":{"error":{"type":"validation_error","code":"current_cost_source_unavailable","message":"The requested supplier is not an eligible active Cost Book lane.","param":"supplierId","requestId":"req-current-source-unavailable"}}}}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/products/{id}/cost-context":{"get":{"operationId":"getPublicAPIProductCostContext","summary":"Get governed product cost context","description":"Returns authoritative current and prior Cost Book entries plus separately labeled completed and pending purchase evidence. supplierId is optional: without it the endpoint follows fixed-supplier or persisted Current Source authority, selects the only eligible lane, or returns a conflict with candidates when multiple unconfigured lanes exist. Explicit supplierId retains exact-lane behavior. Comparisons are emitted only when currency, base unit, cost basis, and evidence timing are compatible. The endpoint requires live Pricing Engine view permission and does not consult the Pricing Engine feature flag.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"cost-book-entries:read","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":false,"name":"supplierId","in":"query"},{"schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"required":false,"name":"asOf","in":"query"}],"responses":{"200":{"description":"Governed product and supplier cost context with source-selection metadata.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"product":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"code":{"type":"string"},"displayName":{"type":"string"},"baseUom":{"type":"string"},"archived":{"type":"boolean","enum":[false]}},"required":["id","code","displayName","baseUom","archived"],"additionalProperties":false},"supplier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"archived":{"type":"boolean","enum":[false]}},"required":["id","displayName","archived"],"additionalProperties":false},"costBookAsOf":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"purchaseEvidenceObservedAt":{"type":"string","format":"date-time"},"currencyCode":{"type":"string","minLength":3,"maxLength":3},"currentCostBookEntry":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"entryType":{"type":"string","enum":["direct","constructed"]},"effectiveFrom":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"effectiveTo":{"type":["string","null"],"pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"cost":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string","minLength":3,"maxLength":3},"uom":{"type":"string"},"comparisonBasis":{"type":"string","enum":["material","landed","unclassified"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom","comparisonBasis"],"additionalProperties":false},"resolutionState":{"type":"string","enum":["resolved","quantity_required","unavailable"]},"completeness":{"type":"string","enum":["complete","unresolved"]},"warningCodes":{"type":"array","items":{"type":"string"}},"rates":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"integer","minimum":0},"amount":{"type":"object","properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string","minLength":3,"maxLength":3},"uom":{"type":"string","minLength":1}},"required":["decimalCentsPerBaseUom","currencyCode","uom"],"additionalProperties":false},"minimumQuantity":{"type":["string","null"]},"minimumBasis":{"type":["string","null"],"enum":["product_uom","package"]},"minimumPackage":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","minLength":1},"quantity":{"type":"string"},"uom":{"type":"string","minLength":1}},"required":["id","name","quantity","uom"],"additionalProperties":false}},"required":["sequence","amount","minimumQuantity","minimumBasis","minimumPackage"],"additionalProperties":false},"maxItems":50}},"required":["id","entryType","effectiveFrom","effectiveTo","cost","resolutionState","completeness","warningCodes","rates"],"additionalProperties":false},"priorCostBookEntry":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"entryType":{"type":"string","enum":["direct","constructed"]},"effectiveFrom":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"effectiveTo":{"type":["string","null"],"pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"cost":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string","minLength":3,"maxLength":3},"uom":{"type":"string"},"comparisonBasis":{"type":"string","enum":["material","landed","unclassified"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom","comparisonBasis"],"additionalProperties":false},"resolutionState":{"type":"string","enum":["resolved","quantity_required","unavailable"]},"completeness":{"type":"string","enum":["complete","unresolved"]},"warningCodes":{"type":"array","items":{"type":"string"}},"rates":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"integer","minimum":0},"amount":{"type":"object","properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string","minLength":3,"maxLength":3},"uom":{"type":"string","minLength":1}},"required":["decimalCentsPerBaseUom","currencyCode","uom"],"additionalProperties":false},"minimumQuantity":{"type":["string","null"]},"minimumBasis":{"type":["string","null"],"enum":["product_uom","package"]},"minimumPackage":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","minLength":1},"quantity":{"type":"string"},"uom":{"type":"string","minLength":1}},"required":["id","name","quantity","uom"],"additionalProperties":false}},"required":["sequence","amount","minimumQuantity","minimumBasis","minimumPackage"],"additionalProperties":false},"maxItems":50}},"required":["id","entryType","effectiveFrom","effectiveTo","cost","resolutionState","completeness","warningCodes","rates"],"additionalProperties":false},"lastCompletedPurchase":{"type":["object","null"],"properties":{"materialCost":{"type":"object","properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string","minLength":3,"maxLength":3},"uom":{"type":"string"},"comparisonBasis":{"type":"string","enum":["material","landed","unclassified"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom","comparisonBasis"],"additionalProperties":false},"landedCost":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string","minLength":3,"maxLength":3},"uom":{"type":"string"},"comparisonBasis":{"type":"string","enum":["material","landed","unclassified"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom","comparisonBasis"],"additionalProperties":false},"sourceDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"observedAt":{"type":"string","format":"date-time"},"status":{"type":"string","enum":["completed","pending"]},"sourceReference":{"type":"string","minLength":1}},"required":["materialCost","landedCost","sourceDate","observedAt","status","sourceReference"],"additionalProperties":false},"latestOnOrderPurchase":{"type":["object","null"],"properties":{"materialCost":{"type":"object","properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string","minLength":3,"maxLength":3},"uom":{"type":"string"},"comparisonBasis":{"type":"string","enum":["material","landed","unclassified"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom","comparisonBasis"],"additionalProperties":false},"landedCost":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string","minLength":3,"maxLength":3},"uom":{"type":"string"},"comparisonBasis":{"type":"string","enum":["material","landed","unclassified"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom","comparisonBasis"],"additionalProperties":false},"sourceDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"observedAt":{"type":"string","format":"date-time"},"status":{"type":"string","enum":["completed","pending"]},"sourceReference":{"type":"string","minLength":1}},"required":["materialCost","landedCost","sourceDate","observedAt","status","sourceReference"],"additionalProperties":false},"comparisons":{"type":"object","properties":{"currentVsPrior":{"type":"object","properties":{"left":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string","minLength":3,"maxLength":3},"uom":{"type":"string"},"comparisonBasis":{"type":"string","enum":["material","landed","unclassified"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom","comparisonBasis"],"additionalProperties":false},"right":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string","minLength":3,"maxLength":3},"uom":{"type":"string"},"comparisonBasis":{"type":"string","enum":["material","landed","unclassified"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom","comparisonBasis"],"additionalProperties":false},"comparable":{"type":"boolean"},"amountDeltaCentsPerBaseUom":{"type":["string","null"]},"percentageDelta":{"type":["string","null"]},"reason":{"type":["string","null"]},"temporalRelation":{"type":["string","null"],"enum":["evidence_precedes_cost_book_as_of","same_day_as_cost_book_as_of","evidence_postdates_cost_book_as_of"]}},"required":["left","right","comparable","amountDeltaCentsPerBaseUom","percentageDelta","reason","temporalRelation"],"additionalProperties":false},"currentVsCompleted":{"type":"object","properties":{"left":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string","minLength":3,"maxLength":3},"uom":{"type":"string"},"comparisonBasis":{"type":"string","enum":["material","landed","unclassified"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom","comparisonBasis"],"additionalProperties":false},"right":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string","minLength":3,"maxLength":3},"uom":{"type":"string"},"comparisonBasis":{"type":"string","enum":["material","landed","unclassified"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom","comparisonBasis"],"additionalProperties":false},"comparable":{"type":"boolean"},"amountDeltaCentsPerBaseUom":{"type":["string","null"]},"percentageDelta":{"type":["string","null"]},"reason":{"type":["string","null"]},"temporalRelation":{"type":["string","null"],"enum":["evidence_precedes_cost_book_as_of","same_day_as_cost_book_as_of","evidence_postdates_cost_book_as_of"]}},"required":["left","right","comparable","amountDeltaCentsPerBaseUom","percentageDelta","reason","temporalRelation"],"additionalProperties":false},"currentVsPending":{"type":"object","properties":{"left":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string","minLength":3,"maxLength":3},"uom":{"type":"string"},"comparisonBasis":{"type":"string","enum":["material","landed","unclassified"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom","comparisonBasis"],"additionalProperties":false},"right":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string","minLength":3,"maxLength":3},"uom":{"type":"string"},"comparisonBasis":{"type":"string","enum":["material","landed","unclassified"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom","comparisonBasis"],"additionalProperties":false},"comparable":{"type":"boolean"},"amountDeltaCentsPerBaseUom":{"type":["string","null"]},"percentageDelta":{"type":["string","null"]},"reason":{"type":["string","null"]},"temporalRelation":{"type":["string","null"],"enum":["evidence_precedes_cost_book_as_of","same_day_as_cost_book_as_of","evidence_postdates_cost_book_as_of"]}},"required":["left","right","comparable","amountDeltaCentsPerBaseUom","percentageDelta","reason","temporalRelation"],"additionalProperties":false}},"required":["currentVsPrior","currentVsCompleted","currentVsPending"],"additionalProperties":false},"expectedCurrentEntryId":{"type":["string","null"],"format":"uuid"},"completeness":{"type":"string","enum":["complete","partial","missing","unresolved"]},"warningCodes":{"type":"array","items":{"type":"string"}},"sourceSelection":{"type":"object","properties":{"resolutionMode":{"type":"string","enum":["explicit","fixed_supplier","current_source","only_available"]},"authorityState":{"type":["string","null"],"enum":["fixed_supplier","current_source","unconfigured","unavailable"]},"resolvedSupplierId":{"type":"string","format":"uuid"},"candidateCount":{"type":"integer","minimum":0},"candidates":{"type":"array","items":{"type":"object","properties":{"supplierId":{"type":"string","format":"uuid"},"supplierName":{"type":"string"},"evidenceSource":{"type":"string","enum":["active_book","construction"]}},"required":["supplierId","supplierName","evidenceSource"],"additionalProperties":false}},"selectionProvenance":{"type":["object","null"],"properties":{"selectedAt":{"type":"string"},"selectedById":{"type":"string","format":"uuid"},"selectedByName":{"type":"string"}},"required":["selectedAt","selectedById","selectedByName"],"additionalProperties":false},"unavailabilityReason":{"type":["string","null"]}},"required":["resolutionMode","authorityState","resolvedSupplierId","candidateCount","candidates","selectionProvenance","unavailabilityReason"],"additionalProperties":false}},"required":["product","supplier","costBookAsOf","purchaseEvidenceObservedAt","currencyCode","currentCostBookEntry","priorCostBookEntry","lastCompletedPurchase","latestOnOrderPurchase","comparisons","expectedCurrentEntryId","completeness","warningCodes","sourceSelection"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"409":{"description":"Source selection is ambiguous or the persisted Current Source is unavailable. The error code is cost_source_ambiguous or current_cost_source_unavailable; ambiguity includes the complete candidate set in error.example.candidates.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["conflict"]},"code":{"type":"string","enum":["cost_source_ambiguous"]},"message":{"type":"string"},"doNotRetrySameRequest":{"type":"boolean","enum":[true]},"example":{"type":"object","properties":{"candidates":{"type":"array","items":{"type":"object","properties":{"supplierId":{"type":"string","format":"uuid"},"supplierName":{"type":"string"},"evidenceSource":{"type":"string","enum":["active_book","construction"]}},"required":["supplierId","supplierName","evidenceSource"],"additionalProperties":false},"minItems":2}},"required":["candidates"],"additionalProperties":false},"suggestedAction":{"type":"string","enum":["choose_valid_value"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json"]},"requestId":{"type":"string"}},"required":["type","code","message","doNotRetrySameRequest","example","suggestedAction","documentationPath","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false},{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["conflict","validation_error"]},"code":{"type":"string","enum":["current_cost_source_unavailable"]},"message":{"type":"string"},"param":{"type":"string","enum":["supplierId"]},"retryable":{"type":"boolean","enum":[false]},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}]},"examples":{"ambiguous-cost-source":{"summary":"Multiple eligible supplier lanes require an explicit supplierId","value":{"error":{"type":"conflict","code":"cost_source_ambiguous","message":"Multiple eligible Cost Book supplier lanes are available; provide supplierId.","doNotRetrySameRequest":true,"example":{"candidates":[{"supplierId":"22222222-2222-4222-8222-222222222222","supplierName":"Primary Chemical Supply","evidenceSource":"active_book"},{"supplierId":"33333333-3333-4333-8333-333333333333","supplierName":"Alternate Chemical Supply","evidenceSource":"construction"}]},"suggestedAction":"choose_valid_value","documentationPath":"/api/v1/openapi.json","requestId":"req-cost-source-ambiguous"}}},"unavailable-current-source":{"summary":"Persisted Current Source authority cannot be used","value":{"error":{"type":"conflict","code":"current_cost_source_unavailable","message":"The selected Current Source is unavailable. Ask a Pricing Engine administrator to replace or clear it.","retryable":false,"requestId":"req-current-source-unavailable"}}}}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/cost-book-entries":{"get":{"operationId":"findPublicAPICostBookEntries","summary":"Read current or historical Cost Book entries","description":"Returns current Cost Book entries or the history for one product and supplier. Amounts preserve their decimal precision, and every result follows the current user's Cost Book access.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"cost-book-entries:read","parameters":[{"schema":{"type":"string"},"required":false,"name":"createdById","in":"query"},{"schema":{"type":"string"},"required":false,"name":"createdFrom","in":"query"},{"schema":{"type":"string"},"required":false,"name":"createdTo","in":"query"},{"schema":{"type":"string"},"required":false,"name":"view","in":"query"},{"schema":{"type":"string"},"required":false,"name":"asOf","in":"query"},{"schema":{"type":"string"},"required":false,"name":"productId","in":"query"},{"schema":{"type":"string"},"required":false,"name":"supplierId","in":"query"},{"schema":{"type":"string"},"required":false,"name":"shipFromLocationId","in":"query"},{"schema":{"type":"string"},"required":false,"name":"entryType","in":"query"},{"schema":{"type":"string"},"required":false,"name":"effectiveState","in":"query"},{"schema":{"type":"string"},"required":false,"name":"versionState","in":"query"},{"schema":{"type":"string"},"required":false,"name":"claimRole","in":"query"},{"schema":{"type":"string"},"required":false,"name":"disposition","in":"query"},{"schema":{"type":"string"},"required":false,"name":"completeness","in":"query"},{"schema":{"type":"string","enum":["true","false"]},"required":false,"name":"includeArchivedEntities","in":"query"},{"schema":{"type":"string","pattern":"^\\d+$"},"required":false,"name":"limit","in":"query"},{"schema":{"type":"string"},"required":false,"name":"cursor","in":"query"}],"responses":{"200":{"description":"Current or historical Cost Book entries and signed cursor metadata.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["user"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["system"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string","enum":["System User"]}},"required":["type","id","displayName"],"additionalProperties":false}]},"resourceType":{"type":"string","enum":["cost_book_entry"]},"entryType":{"type":"string","enum":["direct","constructed"]},"product":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"code":{"type":"string"},"displayName":{"type":"string"},"archived":{"type":"boolean"},"url":{"type":"string","format":"uri"}},"required":["id","code","displayName","archived","url"],"additionalProperties":false},"supplier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"externalId":{"type":["string","null"]},"archived":{"type":"boolean"},"url":{"type":"string","format":"uri"}},"required":["id","displayName","externalId","archived","url"],"additionalProperties":false},"arrangement":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"kind":{"type":"string","enum":["GENERAL","AT_PICKUP","AT_DESTINATION"]},"isTaught":{"type":"boolean"}},"required":["id","name","kind","isTaught"],"additionalProperties":false},"shipFromLocation":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false},"incoterm":{"type":["string","null"],"enum":["EXW","FCA","FAS","FOB","CFR","CIF","CPT","CIP","DAP","DPU","DDP","None"]},"supplierTerms":{"type":["string","null"]},"rates":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"integer","minimum":0},"amount":{"type":"object","properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string"},"uom":{"type":"string","enum":["GALLON","LITER","POUND","KILOGRAM","EACH","METRIC_TON","SHORT_TON"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom"],"additionalProperties":false},"minimumQuantity":{"type":["string","null"]},"minimumBasis":{"type":["string","null"],"enum":["product_uom","package"]},"minimumPackage":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"quantity":{"type":"string"},"uom":{"type":"string"}},"required":["id","name","quantity","uom"],"additionalProperties":false}},"required":["sequence","amount","minimumQuantity","minimumBasis","minimumPackage"],"additionalProperties":false}},"lineage":{"type":["object","null"],"properties":{"authoredByMode":{"type":["string","null"],"enum":["updateCost","editCost"]},"authoredAt":{"type":["string","null"],"format":"date-time"},"authoredById":{"type":["string","null"],"format":"uuid"},"supersedesEntryId":{"type":["string","null"],"format":"uuid"},"correctsEntryId":{"type":["string","null"],"format":"uuid"},"supersededAt":{"type":["string","null"],"format":"date-time"}},"required":["authoredByMode","authoredAt","authoredById","supersedesEntryId","correctsEntryId","supersededAt"],"additionalProperties":false},"resolutionState":{"type":"string","enum":["resolved","quantity_required","unavailable"]},"effectiveState":{"type":"string","enum":["active","scheduled","expired"]},"versionState":{"type":"string","enum":["current","superseded"]},"claimRole":{"type":"string","enum":["authoritative","supporting","non_authoritative"]},"disposition":{"type":"string","enum":["eligible","dismissed","archived"]},"effectiveFrom":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"effectiveTo":{"type":["string","null"],"pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"construction":{"type":"object","properties":{"type":{"type":"string","enum":["direct","constructed"]},"startingCost":{"anyOf":[{"type":"object","properties":{"source":{"type":"string","enum":["entered"]},"entryId":{"type":["string","null"],"format":"uuid"},"basis":{"type":["string","null"],"enum":["material","landed"]},"amount":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string"},"uom":{"type":"string","enum":["GALLON","LITER","POUND","KILOGRAM","EACH","METRIC_TON","SHORT_TON"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom"],"additionalProperties":false},"provenance":{"type":["object","null"],"properties":{"origin":{"type":"string","enum":["manual","integration","agent","import"]},"sourceRef":{"type":["string","null"]},"verifiedAt":{"type":["string","null"],"format":"date-time"},"verifiedBy":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["id","displayName"],"additionalProperties":false}},"required":["origin","sourceRef","verifiedAt","verifiedBy"],"additionalProperties":false}},"required":["source","entryId","basis","amount","provenance"],"additionalProperties":false},{"type":"object","properties":{"source":{"type":"string","enum":["cost_book_entry"]},"entryId":{"type":["string","null"],"format":"uuid"},"product":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"code":{"type":"string"},"displayName":{"type":"string"},"archived":{"type":"boolean"},"url":{"type":"string","format":"uri"}},"required":["id","code","displayName","archived","url"],"additionalProperties":false},"basis":{"type":["string","null"],"enum":["material","landed"]},"amount":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string"},"uom":{"type":"string","enum":["GALLON","LITER","POUND","KILOGRAM","EACH","METRIC_TON","SHORT_TON"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom"],"additionalProperties":false},"provenance":{"type":["object","null"],"properties":{"origin":{"type":"string","enum":["manual","integration","agent","import"]},"sourceRef":{"type":["string","null"]},"verifiedAt":{"type":["string","null"],"format":"date-time"},"verifiedBy":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["id","displayName"],"additionalProperties":false}},"required":["origin","sourceRef","verifiedAt","verifiedBy"],"additionalProperties":false}},"required":["source","entryId","product","basis","amount","provenance"],"additionalProperties":false}]},"additionalCosts":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"integer","minimum":0},"class":{"type":"string","enum":["FREIGHT","PACKAGING","DUTY","STORAGE","PROCESSING","HANDLING","TAX","OTHER"]},"method":{"type":"string","enum":["percent_of_starting_cost","cents_per_base_uom","cents_per_package"]},"value":{"type":"string"},"description":{"type":["string","null"]},"resolvedContribution":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string"},"uom":{"type":"string","enum":["GALLON","LITER","POUND","KILOGRAM","EACH","METRIC_TON","SHORT_TON"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom"],"additionalProperties":false}},"required":["sequence","class","method","value","description","resolvedContribution"],"additionalProperties":false}}},"required":["type","startingCost","additionalCosts"],"additionalProperties":false},"additionalCostTotal":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string"},"uom":{"type":"string","enum":["GALLON","LITER","POUND","KILOGRAM","EACH","METRIC_TON","SHORT_TON"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom"],"additionalProperties":false},"totalCost":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string"},"uom":{"type":"string","enum":["GALLON","LITER","POUND","KILOGRAM","EACH","METRIC_TON","SHORT_TON"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom"],"additionalProperties":false},"provenance":{"type":"object","properties":{"origin":{"type":"string","enum":["manual","integration","agent","import"]},"sourceRef":{"type":["string","null"]},"verifiedAt":{"type":["string","null"],"format":"date-time"},"verifiedBy":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["id","displayName"],"additionalProperties":false}},"required":["origin","sourceRef","verifiedAt","verifiedBy"],"additionalProperties":false},"completeness":{"type":"object","properties":{"status":{"type":"string","enum":["complete","unresolved"]},"warningCodes":{"type":"array","items":{"type":"string"}}},"required":["status","warningCodes"],"additionalProperties":false},"waitingReason":{"type":"string","description":"Present when a constructed entry has no total because its starting price is not current."},"costBookUrl":{"type":"string","format":"uri"}},"required":["id","createdAt","resourceType","entryType","product","supplier","shipFromLocation","incoterm","supplierTerms","rates","resolutionState","effectiveState","versionState","claimRole","disposition","effectiveFrom","effectiveTo","construction","additionalCostTotal","totalCost","provenance","completeness","costBookUrl"],"additionalProperties":false}},"meta":{"type":"object","properties":{"view":{"type":"string","enum":["current","history"]},"asOf":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"limit":{"type":"integer"},"hasMore":{"type":"boolean"},"nextCursor":{"type":["string","null"]},"matchStatus":{"type":"string","enum":["matched","missing","unresolved"]},"completeness":{"type":"object","properties":{"completeCount":{"type":"integer"},"unresolvedCount":{"type":"integer"}},"required":["completeCount","unresolvedCount"],"additionalProperties":false},"warnings":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"generatedAt":{"type":"string","format":"date-time"}},"required":["view","asOf","limit","hasMore","nextCursor","completeness","warnings","generatedAt"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false},"examples":{"current-direct-complete":{"summary":"Current direct Cost Book entry","value":{"data":[{"id":"44444444-4444-4444-8444-444444444444","createdAt":"2026-07-14T14:00:00.000Z","createdBy":{"type":"user","id":"66666666-6666-4666-8666-666666666666","displayName":"API Cost Operator"},"resourceType":"cost_book_entry","entryType":"direct","product":{"id":"11111111-1111-4111-8111-111111111111","code":"RESIN-100","displayName":"Resin 100","archived":false,"url":"https://app.shelfcycle.com/acme/products/11111111-1111-4111-8111-111111111111"},"supplier":{"id":"22222222-2222-4222-8222-222222222222","displayName":"Acme Chemical Supply","externalId":"SUP-100","archived":false,"url":"https://app.shelfcycle.com/acme/suppliers/22222222-2222-4222-8222-222222222222"},"shipFromLocation":null,"incoterm":null,"supplierTerms":"Net 30. Pricing applies to full truckload quantities.","rates":[{"sequence":0,"amount":{"decimalCentsPerBaseUom":"49.5","currencyCode":"USD","uom":"POUND"},"minimumQuantity":null,"minimumBasis":null,"minimumPackage":null}],"resolutionState":"resolved","effectiveState":"active","versionState":"current","claimRole":"authoritative","disposition":"eligible","effectiveFrom":"2026-07-14","effectiveTo":null,"construction":{"type":"direct","startingCost":{"source":"entered","entryId":"44444444-4444-4444-8444-444444444444","basis":"material","amount":{"decimalCentsPerBaseUom":"49.5","currencyCode":"USD","uom":"POUND"},"provenance":{"origin":"integration","sourceRef":"quote-2026-0714-line-4","verifiedAt":"2026-07-14T14:30:00.000Z","verifiedBy":{"id":"66666666-6666-4666-8666-666666666666","displayName":"API Cost Operator"}}},"additionalCosts":[]},"additionalCostTotal":{"decimalCentsPerBaseUom":"0","currencyCode":"USD","uom":"POUND"},"totalCost":{"decimalCentsPerBaseUom":"49.5","currencyCode":"USD","uom":"POUND"},"provenance":{"origin":"integration","sourceRef":"quote-2026-0714-line-4","verifiedAt":"2026-07-14T14:30:00.000Z","verifiedBy":{"id":"66666666-6666-4666-8666-666666666666","displayName":"API Cost Operator"}},"completeness":{"status":"complete","warningCodes":[]},"costBookUrl":"https://app.shelfcycle.com/acme/pricing-engine/cost-book"}],"meta":{"view":"current","asOf":"2026-07-14","limit":25,"hasMore":false,"nextCursor":null,"matchStatus":"matched","completeness":{"completeCount":1,"unresolvedCount":0},"warnings":[],"generatedAt":"2026-07-14T14:31:00.000Z"}}},"current-self-base-constructed":{"summary":"Current construction based on the target product","value":{"data":[{"id":"44444444-4444-4444-8444-444444444444","createdAt":"2026-07-14T14:00:00.000Z","createdBy":{"type":"user","id":"66666666-6666-4666-8666-666666666666","displayName":"API Cost Operator"},"resourceType":"cost_book_entry","entryType":"constructed","product":{"id":"11111111-1111-4111-8111-111111111111","code":"RESIN-100","displayName":"Resin 100","archived":false,"url":"https://app.shelfcycle.com/acme/products/11111111-1111-4111-8111-111111111111"},"supplier":{"id":"22222222-2222-4222-8222-222222222222","displayName":"Acme Chemical Supply","externalId":"SUP-100","archived":false,"url":"https://app.shelfcycle.com/acme/suppliers/22222222-2222-4222-8222-222222222222"},"shipFromLocation":null,"incoterm":null,"supplierTerms":null,"rates":[],"resolutionState":"resolved","effectiveState":"active","versionState":"current","claimRole":"authoritative","disposition":"eligible","effectiveFrom":"2026-07-14","effectiveTo":null,"construction":{"type":"constructed","startingCost":{"source":"cost_book_entry","entryId":"55555555-5555-4555-8555-555555555555","product":{"id":"11111111-1111-4111-8111-111111111111","code":"RESIN-100","displayName":"Resin 100","archived":false,"url":"https://app.shelfcycle.com/acme/products/11111111-1111-4111-8111-111111111111"},"basis":"material","amount":{"decimalCentsPerBaseUom":"50","currencyCode":"USD","uom":"POUND"},"provenance":{"origin":"integration","sourceRef":"quote-2026-0714-line-4","verifiedAt":"2026-07-14T14:30:00.000Z","verifiedBy":{"id":"66666666-6666-4666-8666-666666666666","displayName":"API Cost Operator"}}},"additionalCosts":[{"sequence":1,"class":"FREIGHT","method":"percent_of_starting_cost","value":"5","description":"Inbound freight","resolvedContribution":{"decimalCentsPerBaseUom":"2.5","currencyCode":"USD","uom":"POUND"}}]},"additionalCostTotal":{"decimalCentsPerBaseUom":"2.5","currencyCode":"USD","uom":"POUND"},"totalCost":{"decimalCentsPerBaseUom":"52.5","currencyCode":"USD","uom":"POUND"},"provenance":{"origin":"integration","sourceRef":"quote-2026-0714-line-4","verifiedAt":"2026-07-14T14:30:00.000Z","verifiedBy":{"id":"66666666-6666-4666-8666-666666666666","displayName":"API Cost Operator"}},"completeness":{"status":"complete","warningCodes":[]},"costBookUrl":"https://app.shelfcycle.com/acme/pricing-engine/cost-book"}],"meta":{"view":"current","asOf":"2026-07-14","limit":25,"hasMore":false,"nextCursor":null,"matchStatus":"matched","completeness":{"completeCount":1,"unresolvedCount":0},"warnings":[],"generatedAt":"2026-07-14T14:31:00.000Z"}}},"current-alternate-base-constructed":{"summary":"Current construction based on another product","value":{"data":[{"id":"44444444-4444-4444-8444-444444444444","createdAt":"2026-07-14T14:00:00.000Z","createdBy":{"type":"user","id":"66666666-6666-4666-8666-666666666666","displayName":"API Cost Operator"},"resourceType":"cost_book_entry","entryType":"constructed","product":{"id":"11111111-1111-4111-8111-111111111111","code":"RESIN-100","displayName":"Resin 100","archived":false,"url":"https://app.shelfcycle.com/acme/products/11111111-1111-4111-8111-111111111111"},"supplier":{"id":"22222222-2222-4222-8222-222222222222","displayName":"Acme Chemical Supply","externalId":"SUP-100","archived":false,"url":"https://app.shelfcycle.com/acme/suppliers/22222222-2222-4222-8222-222222222222"},"shipFromLocation":null,"incoterm":null,"supplierTerms":null,"rates":[],"resolutionState":"resolved","effectiveState":"active","versionState":"current","claimRole":"authoritative","disposition":"eligible","effectiveFrom":"2026-07-14","effectiveTo":null,"construction":{"type":"constructed","startingCost":{"source":"cost_book_entry","entryId":"55555555-5555-4555-8555-555555555555","product":{"id":"33333333-3333-4333-8333-333333333333","code":"BASE-200","displayName":"Base Resin 200","archived":false,"url":"https://app.shelfcycle.com/acme/products/33333333-3333-4333-8333-333333333333"},"basis":"landed","amount":{"decimalCentsPerBaseUom":"55","currencyCode":"USD","uom":"POUND"},"provenance":{"origin":"integration","sourceRef":"quote-2026-0714-line-4","verifiedAt":"2026-07-14T14:30:00.000Z","verifiedBy":{"id":"66666666-6666-4666-8666-666666666666","displayName":"API Cost Operator"}}},"additionalCosts":[{"sequence":1,"class":"HANDLING","method":"cents_per_base_uom","value":"5","description":null,"resolvedContribution":{"decimalCentsPerBaseUom":"5","currencyCode":"USD","uom":"POUND"}}]},"additionalCostTotal":{"decimalCentsPerBaseUom":"5","currencyCode":"USD","uom":"POUND"},"totalCost":{"decimalCentsPerBaseUom":"60","currencyCode":"USD","uom":"POUND"},"provenance":{"origin":"integration","sourceRef":"quote-2026-0714-line-4","verifiedAt":"2026-07-14T14:30:00.000Z","verifiedBy":{"id":"66666666-6666-4666-8666-666666666666","displayName":"API Cost Operator"}},"completeness":{"status":"complete","warningCodes":[]},"costBookUrl":"https://app.shelfcycle.com/acme/pricing-engine/cost-book"}],"meta":{"view":"current","asOf":"2026-07-14","limit":25,"hasMore":false,"nextCursor":null,"matchStatus":"matched","completeness":{"completeCount":1,"unresolvedCount":0},"warnings":[],"generatedAt":"2026-07-14T14:31:00.000Z"}}},"history-unresolved-null-total":{"summary":"Historical unresolved construction with no invented total","value":{"data":[{"id":"44444444-4444-4444-8444-444444444444","createdAt":"2026-07-14T14:00:00.000Z","createdBy":{"type":"user","id":"66666666-6666-4666-8666-666666666666","displayName":"API Cost Operator"},"resourceType":"cost_book_entry","entryType":"constructed","product":{"id":"11111111-1111-4111-8111-111111111111","code":"RESIN-100","displayName":"Resin 100","archived":false,"url":"https://app.shelfcycle.com/acme/products/11111111-1111-4111-8111-111111111111"},"supplier":{"id":"22222222-2222-4222-8222-222222222222","displayName":"Acme Chemical Supply","externalId":"SUP-100","archived":false,"url":"https://app.shelfcycle.com/acme/suppliers/22222222-2222-4222-8222-222222222222"},"shipFromLocation":null,"incoterm":null,"supplierTerms":null,"rates":[],"resolutionState":"unavailable","effectiveState":"expired","versionState":"superseded","claimRole":"supporting","disposition":"eligible","effectiveFrom":"2026-07-14","effectiveTo":"2026-07-13","construction":{"type":"constructed","startingCost":{"source":"cost_book_entry","entryId":null,"product":{"id":"33333333-3333-4333-8333-333333333333","code":"BASE-200","displayName":"Base Resin 200","archived":false,"url":"https://app.shelfcycle.com/acme/products/33333333-3333-4333-8333-333333333333"},"basis":null,"amount":null,"provenance":null},"additionalCosts":[{"sequence":1,"class":"HANDLING","method":"cents_per_base_uom","value":"5","description":null,"resolvedContribution":null}]},"additionalCostTotal":null,"totalCost":null,"provenance":{"origin":"integration","sourceRef":"quote-2026-0714-line-4","verifiedAt":"2026-07-14T14:30:00.000Z","verifiedBy":{"id":"66666666-6666-4666-8666-666666666666","displayName":"API Cost Operator"}},"completeness":{"status":"unresolved","warningCodes":["starting_cost_unavailable"]},"costBookUrl":"https://app.shelfcycle.com/acme/pricing-engine/cost-book"}],"meta":{"view":"history","asOf":"2026-07-14","limit":25,"hasMore":false,"nextCursor":null,"completeness":{"completeCount":0,"unresolvedCount":1},"warnings":[{"code":"page_contains_unresolved_entries","message":"This page contains unresolved entries."}],"generatedAt":"2026-07-14T14:31:00.000Z"}}}}}}},"401":{"description":"Bearer API key is missing, invalid, expired, revoked, or issued to an inactive actor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"The API key is missing a required scope or the acting user lacks current ShelfCycle access permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"The requested record was not found in the authenticated org.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Request validation failed. Validation responses include param and errors[].","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The API key exceeded its rate limit.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Positive delay in seconds before retrying the active window.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"500":{"description":"An unexpected server error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"A required dependent service is temporarily unavailable. Retry after the indicated delay.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["auth_error","method_error","permission_error","validation_error","not_found","conflict","rate_limit_error","server_error"]},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"narrowingHints":{"type":"array","items":{"type":"string"}},"retryable":{"type":"boolean"},"retryAfterSeconds":{"type":"integer"},"doNotRetrySameRequest":{"type":"boolean"},"acceptedFilters":{"type":"array","items":{"type":"string"}},"requiredCombination":{"type":"array","items":{"type":"string"}},"maxWindowDays":{"type":"integer"},"example":{"type":"object","additionalProperties":{}},"validValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"suggestedAction":{"type":"string","enum":["add_required_filter","replace_param","choose_valid_value","pair_date_window","narrow_filter","wait_and_retry","stop_and_fix_request","inspect_write_readiness_checks"]},"documentationPath":{"type":"string","enum":["/api/v1/openapi.json","/llms.txt"]},"repairCategory":{"type":"string","enum":["missing_required_filter","unknown_param","invalid_enum","invalid_limit","missing_required_combination","unsupported_filter","unsupported_sync_filter","standalone_status","invalid_window","invalid_datetime","invalid_identifier","rate_limited","write_readiness_validation"]},"writeReadiness":{"type":"object","additionalProperties":{}},"impactAnalysis":{"type":"object","additionalProperties":{}},"repairContext":{"type":"object","properties":{"rule":{"type":"string"},"expected":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"received":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"readPath":{"type":"string"},"affectedEntryIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["rule"],"additionalProperties":false},"requestId":{"type":"string"}},"required":["type","code","message","requestId"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}},"post":{"operationId":"createPublicAPICostBookEntry","summary":"Create the next Cost Book version","description":"Creates one complete direct or constructed Cost Book entry. Use dryRun=true to review readiness without saving, then send expectedCurrentEntryId and Idempotency-Key to apply the update.","tags":["Public API v1"],"security":[{"bearerAuth":[]}],"x-required-scope":"cost-book-entries:write","parameters":[{"schema":{"type":"string","enum":["true"]},"required":false,"name":"dryRun","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Required for execute requests. dryRun=true may omit this header and receive an idempotency_key_required check."},"required":false,"description":"Required for execute requests. dryRun=true may omit this header and receive an idempotency_key_required check.","name":"Idempotency-Key","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"productId":{"type":"string","format":"uuid"},"supplierId":{"type":"string","format":"uuid"},"expectedCurrentEntryId":{"type":["string","null"],"format":"uuid"},"effectiveFrom":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"effectiveTo":{"type":["string","null"],"pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"note":{"type":["string","null"],"maxLength":2000},"sourceRef":{"type":["string","null"],"maxLength":500},"terms":{"type":["string","null"],"maxLength":4000},"arrangementId":{"type":["string","null"],"format":"uuid"},"newArrangement":{"type":["object","null"],"properties":{"name":{"type":"string","minLength":1,"maxLength":160},"kind":{"type":"string","enum":["GENERAL","AT_PICKUP","AT_DESTINATION"]},"shipFromLocationId":{"type":["string","null"],"format":"uuid"},"destinationScope":{"type":["object","null"],"properties":{"countryCode":{"type":["string","null"],"minLength":2,"maxLength":2},"state":{"type":["string","null"],"maxLength":120},"city":{"type":["string","null"],"maxLength":120}},"additionalProperties":false}},"required":["name","kind"],"additionalProperties":false},"shipFromLocationId":{"type":["string","null"],"format":"uuid"},"incoterm":{"type":["string","null"],"enum":["EXW","FCA","FAS","FOB","CFR","CIF","CPT","CIP","DAP","DPU","DDP","None"]},"construction":{"type":"object","properties":{"type":{"type":"string","enum":["direct"]},"basis":{"type":"string","enum":["material","landed"]},"uom":{"type":"string","enum":["GALLON","LITER","POUND","KILOGRAM","EACH","METRIC_TON","SHORT_TON"]},"costPerBaseUomCents":{"type":"string"},"rates":{"type":"array","items":{"type":"object","properties":{"costPerBaseUomCents":{"type":"string"},"minimumQuantity":{"type":["string","null"]},"minimumBasis":{"type":["string","null"],"enum":["product_uom","package"]},"minimumProductPackagingId":{"type":["string","null"],"format":"uuid"}},"required":["costPerBaseUomCents"],"additionalProperties":false},"minItems":1,"maxItems":50}},"required":["type","basis","uom"],"additionalProperties":false}},"required":["productId","supplierId","expectedCurrentEntryId","effectiveFrom","construction"],"additionalProperties":false},{"type":"object","properties":{"productId":{"type":"string","format":"uuid"},"supplierId":{"type":"string","format":"uuid"},"expectedCurrentEntryId":{"type":["string","null"],"format":"uuid"},"effectiveFrom":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"effectiveTo":{"type":["string","null"],"pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"note":{"type":["string","null"],"maxLength":2000},"sourceRef":{"type":["string","null"],"maxLength":500},"terms":{"type":["string","null"],"maxLength":4000},"arrangementId":{"type":["string","null"],"format":"uuid"},"newArrangement":{"type":["object","null"],"properties":{"name":{"type":"string","minLength":1,"maxLength":160},"kind":{"type":"string","enum":["GENERAL","AT_PICKUP","AT_DESTINATION"]},"shipFromLocationId":{"type":["string","null"],"format":"uuid"},"destinationScope":{"type":["object","null"],"properties":{"countryCode":{"type":["string","null"],"minLength":2,"maxLength":2},"state":{"type":["string","null"],"maxLength":120},"city":{"type":["string","null"],"maxLength":120}},"additionalProperties":false}},"required":["name","kind"],"additionalProperties":false},"shipFromLocationId":{"type":["string","null"],"format":"uuid"},"incoterm":{"type":"null"},"construction":{"type":"object","properties":{"type":{"type":"string","enum":["constructed"]},"startingCost":{"type":"object","properties":{"source":{"type":"string","enum":["entered"]},"basis":{"type":"string","enum":["material","landed"]},"uom":{"type":"string","enum":["GALLON","LITER","POUND","KILOGRAM","EACH","METRIC_TON","SHORT_TON"]},"costPerBaseUomCents":{"type":"string"}},"required":["source","basis","uom","costPerBaseUomCents"],"additionalProperties":false},"additionalCosts":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"class":{"type":"string","enum":["FREIGHT","PACKAGING","DUTY","STORAGE","PROCESSING","HANDLING","TAX","OTHER"]},"method":{"type":"string","enum":["percent_of_starting_cost"]},"value":{"type":"string","pattern":"^(?:100(?:\\.0{1,16})?|(?:[1-9]\\d?)(?:\\.\\d{1,16})?|0\\.(?=\\d{1,16}$)(?=.*[1-9])\\d+)$"},"description":{"type":["string","null"],"maxLength":500}},"required":["class","method","value"],"additionalProperties":false},{"type":"object","properties":{"class":{"type":"string","enum":["FREIGHT","PACKAGING","DUTY","STORAGE","PROCESSING","HANDLING","TAX","OTHER"]},"method":{"type":"string","enum":["cents_per_base_uom","cents_per_package"]},"value":{"type":"string"},"description":{"type":["string","null"],"maxLength":500}},"required":["class","method","value"],"additionalProperties":false}]},"minItems":1,"maxItems":50}},"required":["type","startingCost","additionalCosts"],"additionalProperties":false}},"required":["productId","supplierId","expectedCurrentEntryId","effectiveFrom","construction"],"additionalProperties":false},{"type":"object","properties":{"productId":{"type":"string","format":"uuid"},"supplierId":{"type":"string","format":"uuid"},"expectedCurrentEntryId":{"type":["string","null"],"format":"uuid"},"effectiveFrom":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"effectiveTo":{"type":["string","null"],"pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"note":{"type":["string","null"],"maxLength":2000},"sourceRef":{"type":["string","null"],"maxLength":500},"terms":{"type":["string","null"],"maxLength":4000},"arrangementId":{"type":["string","null"],"format":"uuid"},"newArrangement":{"type":["object","null"],"properties":{"name":{"type":"string","minLength":1,"maxLength":160},"kind":{"type":"string","enum":["GENERAL","AT_PICKUP","AT_DESTINATION"]},"shipFromLocationId":{"type":["string","null"],"format":"uuid"},"destinationScope":{"type":["object","null"],"properties":{"countryCode":{"type":["string","null"],"minLength":2,"maxLength":2},"state":{"type":["string","null"],"maxLength":120},"city":{"type":["string","null"],"maxLength":120}},"additionalProperties":false}},"required":["name","kind"],"additionalProperties":false},"shipFromLocationId":{"type":["string","null"],"format":"uuid"},"incoterm":{"type":"null"},"construction":{"type":"object","properties":{"type":{"type":"string","enum":["constructed"]},"startingCost":{"type":"object","properties":{"source":{"type":"string","enum":["cost_book_entry"]},"productId":{"type":"string","format":"uuid"}},"required":["source","productId"],"additionalProperties":false},"additionalCosts":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"class":{"type":"string","enum":["FREIGHT","PACKAGING","DUTY","STORAGE","PROCESSING","HANDLING","TAX","OTHER"]},"method":{"type":"string","enum":["percent_of_starting_cost"]},"value":{"type":"string","pattern":"^(?:100(?:\\.0{1,16})?|(?:[1-9]\\d?)(?:\\.\\d{1,16})?|0\\.(?=\\d{1,16}$)(?=.*[1-9])\\d+)$"},"description":{"type":["string","null"],"maxLength":500}},"required":["class","method","value"],"additionalProperties":false},{"type":"object","properties":{"class":{"type":"string","enum":["FREIGHT","PACKAGING","DUTY","STORAGE","PROCESSING","HANDLING","TAX","OTHER"]},"method":{"type":"string","enum":["cents_per_base_uom","cents_per_package"]},"value":{"type":"string"},"description":{"type":["string","null"],"maxLength":500}},"required":["class","method","value"],"additionalProperties":false}]},"maxItems":50}},"required":["type","startingCost","additionalCosts"],"additionalProperties":false}},"required":["productId","supplierId","expectedCurrentEntryId","effectiveFrom","construction"],"additionalProperties":false}]}}}},"responses":{"200":{"description":"Idempotent replay receipt, or dryRun returned write readiness.","headers":{"X-RateLimit-Limit":{"description":"Configured request limit for the active API-key, endpoint, and rate-limit-family window.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Requests remaining in the active window after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix epoch time in seconds when the active rate-limit window resets.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Cost":{"description":"Positive request cost charged to the active rate-limit window. Scalar requests cost 1; Cost Book batches cost item units.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["user"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["system"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string","enum":["System User"]}},"required":["type","id","displayName"],"additionalProperties":false}]},"resourceType":{"type":"string","enum":["cost_book_entry"]},"entryType":{"type":"string","enum":["direct","constructed"]},"product":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"code":{"type":"string"},"displayName":{"type":"string"},"archived":{"type":"boolean"},"url":{"type":"string","format":"uri"}},"required":["id","code","displayName","archived","url"],"additionalProperties":false},"supplier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"externalId":{"type":["string","null"]},"archived":{"type":"boolean"},"url":{"type":"string","format":"uri"}},"required":["id","displayName","externalId","archived","url"],"additionalProperties":false},"arrangement":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"kind":{"type":"string","enum":["GENERAL","AT_PICKUP","AT_DESTINATION"]},"isTaught":{"type":"boolean"}},"required":["id","name","kind","isTaught"],"additionalProperties":false},"shipFromLocation":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false},"incoterm":{"type":["string","null"],"enum":["EXW","FCA","FAS","FOB","CFR","CIF","CPT","CIP","DAP","DPU","DDP","None"]},"supplierTerms":{"type":["string","null"]},"rates":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"integer","minimum":0},"amount":{"type":"object","properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string"},"uom":{"type":"string","enum":["GALLON","LITER","POUND","KILOGRAM","EACH","METRIC_TON","SHORT_TON"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom"],"additionalProperties":false},"minimumQuantity":{"type":["string","null"]},"minimumBasis":{"type":["string","null"],"enum":["product_uom","package"]},"minimumPackage":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"quantity":{"type":"string"},"uom":{"type":"string"}},"required":["id","name","quantity","uom"],"additionalProperties":false}},"required":["sequence","amount","minimumQuantity","minimumBasis","minimumPackage"],"additionalProperties":false}},"lineage":{"type":["object","null"],"properties":{"authoredByMode":{"type":["string","null"],"enum":["updateCost","editCost"]},"authoredAt":{"type":["string","null"],"format":"date-time"},"authoredById":{"type":["string","null"],"format":"uuid"},"supersedesEntryId":{"type":["string","null"],"format":"uuid"},"correctsEntryId":{"type":["string","null"],"format":"uuid"},"supersededAt":{"type":["string","null"],"format":"date-time"}},"required":["authoredByMode","authoredAt","authoredById","supersedesEntryId","correctsEntryId","supersededAt"],"additionalProperties":false},"resolutionState":{"type":"string","enum":["resolved","quantity_required","unavailable"]},"effectiveState":{"type":"string","enum":["active","scheduled","expired"]},"versionState":{"type":"string","enum":["current","superseded"]},"claimRole":{"type":"string","enum":["authoritative","supporting","non_authoritative"]},"disposition":{"type":"string","enum":["eligible","dismissed","archived"]},"effectiveFrom":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"effectiveTo":{"type":["string","null"],"pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"construction":{"type":"object","properties":{"type":{"type":"string","enum":["direct","constructed"]},"startingCost":{"anyOf":[{"type":"object","properties":{"source":{"type":"string","enum":["entered"]},"entryId":{"type":["string","null"],"format":"uuid"},"basis":{"type":["string","null"],"enum":["material","landed"]},"amount":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string"},"uom":{"type":"string","enum":["GALLON","LITER","POUND","KILOGRAM","EACH","METRIC_TON","SHORT_TON"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom"],"additionalProperties":false},"provenance":{"type":["object","null"],"properties":{"origin":{"type":"string","enum":["manual","integration","agent","import"]},"sourceRef":{"type":["string","null"]},"verifiedAt":{"type":["string","null"],"format":"date-time"},"verifiedBy":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["id","displayName"],"additionalProperties":false}},"required":["origin","sourceRef","verifiedAt","verifiedBy"],"additionalProperties":false}},"required":["source","entryId","basis","amount","provenance"],"additionalProperties":false},{"type":"object","properties":{"source":{"type":"string","enum":["cost_book_entry"]},"entryId":{"type":["string","null"],"format":"uuid"},"product":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"code":{"type":"string"},"displayName":{"type":"string"},"archived":{"type":"boolean"},"url":{"type":"string","format":"uri"}},"required":["id","code","displayName","archived","url"],"additionalProperties":false},"basis":{"type":["string","null"],"enum":["material","landed"]},"amount":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string"},"uom":{"type":"string","enum":["GALLON","LITER","POUND","KILOGRAM","EACH","METRIC_TON","SHORT_TON"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom"],"additionalProperties":false},"provenance":{"type":["object","null"],"properties":{"origin":{"type":"string","enum":["manual","integration","agent","import"]},"sourceRef":{"type":["string","null"]},"verifiedAt":{"type":["string","null"],"format":"date-time"},"verifiedBy":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["id","displayName"],"additionalProperties":false}},"required":["origin","sourceRef","verifiedAt","verifiedBy"],"additionalProperties":false}},"required":["source","entryId","product","basis","amount","provenance"],"additionalProperties":false}]},"additionalCosts":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"integer","minimum":0},"class":{"type":"string","enum":["FREIGHT","PACKAGING","DUTY","STORAGE","PROCESSING","HANDLING","TAX","OTHER"]},"method":{"type":"string","enum":["percent_of_starting_cost","cents_per_base_uom","cents_per_package"]},"value":{"type":"string"},"description":{"type":["string","null"]},"resolvedContribution":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string"},"uom":{"type":"string","enum":["GALLON","LITER","POUND","KILOGRAM","EACH","METRIC_TON","SHORT_TON"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom"],"additionalProperties":false}},"required":["sequence","class","method","value","description","resolvedContribution"],"additionalProperties":false}}},"required":["type","startingCost","additionalCosts"],"additionalProperties":false},"additionalCostTotal":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string"},"uom":{"type":"string","enum":["GALLON","LITER","POUND","KILOGRAM","EACH","METRIC_TON","SHORT_TON"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom"],"additionalProperties":false},"totalCost":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string"},"uom":{"type":"string","enum":["GALLON","LITER","POUND","KILOGRAM","EACH","METRIC_TON","SHORT_TON"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom"],"additionalProperties":false},"provenance":{"type":"object","properties":{"origin":{"type":"string","enum":["manual","integration","agent","import"]},"sourceRef":{"type":["string","null"]},"verifiedAt":{"type":["string","null"],"format":"date-time"},"verifiedBy":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["id","displayName"],"additionalProperties":false}},"required":["origin","sourceRef","verifiedAt","verifiedBy"],"additionalProperties":false},"completeness":{"type":"object","properties":{"status":{"type":"string","enum":["complete","unresolved"]},"warningCodes":{"type":"array","items":{"type":"string"}}},"required":["status","warningCodes"],"additionalProperties":false},"waitingReason":{"type":"string","description":"Present when a constructed entry has no total because its starting price is not current."},"costBookUrl":{"type":"string","format":"uri"},"idempotencyStatus":{"type":"string","enum":["created","replayed"]},"resultAction":{"type":"string","enum":["created","superseded"]},"warnings":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false}}},"required":["id","createdAt","resourceType","entryType","product","supplier","shipFromLocation","incoterm","supplierTerms","rates","resolutionState","effectiveState","versionState","claimRole","disposition","effectiveFrom","effectiveTo","construction","additionalCostTotal","totalCost","provenance","completeness","costBookUrl","idempotencyStatus","resultAction","warnings"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["write_readiness"]},"operation":{"type":"string","enum":["cost_book_entries.create"]},"status":{"type":"string","enum":["ready","blocked"]},"wouldWrite":{"type":"boolean","enum":[false]},"submit":{"type":"object","properties":{"method":{"type":"string","enum":["POST","PATCH","PUT","DELETE"]},"path":{"type":"string"},"query":{"type":"object","properties":{},"additionalProperties":false}},"required":["method","path","query"],"additionalProperties":false},"verification":{"type":"object","properties":{"available":{"type":"boolean"},"method":{"type":"string","enum":["GET"]},"path":{"type":["string","null"]},"pathTemplate":{"type":"string"},"requiresScopes":{"type":"array","items":{"type":"string","enum":["search:read","tags:read","tags:write","notes:read","notes:write","opportunities:read","opportunities:write","contacts:read","contacts:create","contacts:update","customers:read","customers:write","suppliers:read","suppliers:write","products:read","products:write","documents:upload","orders:read","purchase-orders:read","purchase-order-execution:read","inventory:read","lots:read","reorder:read","warehouses:read","warehouses:write","shipping-options:read","shipping-options:write","reorder:write","certifications:read","purchase-order-documents:write","company-reference:read","company-reference:write","invoices:read","bills:read","customer-payments:read","supplier-payments:read","reports:read","cost-book-entries:read","cost-book-entries:write","current-cost-sources:read","current-cost-sources:write","price-book-entries:read","price-book-entries:write","sent-emails:read"]}},"fallback":{"type":"string","enum":["detail_get","execute_response"]}},"required":["available","method","path","pathTemplate","requiresScopes","fallback"],"additionalProperties":false},"checks":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["not_direct_ship","address_role_required","address_role_valid","already_assigned","already_exists","active_duplicate","ambiguous_external_id","ambiguous_natural_key","api_created","archived_target","archived_record","archive_blocked","account_type_locked","duplicate_candidate_found","duplicate_candidate_overflow","duplicate_check_clear","duplicate_check_not_needed","duplicate_contact","duplicate_customer","duplicate_customer_address","duplicate_customer_location","duplicate_note","duplicate_resolution_applied","duplicate_supplier","duplicate_supplier_ship_from_location","document_url_org_scoped","document_url_valid","upload_verified","sds_converged","idempotency_available","idempotency_key_required","idempotency_key_reused","idempotency_replay","idempotency_target_missing","income_statement_type_invalid","hard_identity_clear","nested_external_id_clear","commercial_references_valid","credit_denomination_mismatch","customer_service_representative_reference_active","ledger_account_reference_valid","payment_terms_reference_exists","sales_person_reference_active","supplier_representative_reference_active","duplicate_reference_identity","external_id_conflict","if_match_current","base_uom_transition_allowed","base_uom_transition_blocked","attribute_assignments_valid","attribute_assignments_invalid","selected_supplier_link","linked_records_available","natural_key_conflict","not_api_created","no_downstream_mutation","order_sensitive_update_allowed","order_sensitive_update_blocked","parent_available","cost_book_entry_blocked","cost_book_entry_valid","cost_book_reference_not_visible","unsupported_cost_book_uom","cost_uom_conversion_unavailable","cost_book_base_unavailable","cost_book_base_ambiguous","cost_ship_from_location_not_visible","cost_package_quantity_invalid","cost_component_invalid","cost_date_window_invalid","cost_date_overlap","cost_amount_overflow","cost_book_conflict","product_family_reference_active","product_packaging_reference_active","primary_child_available","primary_change_unsupported","reference_visibility_blocked","scope_authorized","stale_record","stale_cost_book_entry","supplier_reference_active","tag_applicable","tag_available","tag_exists","tag_found","tag_not_applicable","tag_not_found","type_immutable","type_known","type_required","target_active","target_available","target_not_found_or_not_visible","targets_visible","unsupported_linked_record","unsupported_profile_shape","variable_qty_valid","validation_failed","value_nonempty"]},"status":{"type":"string","enum":["passed","blocked"]},"message":{"type":"string"},"param":{"type":"string"}},"required":["code","status","message"],"additionalProperties":false}},"duplicateCandidates":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contact","customer","supplier","customer_location","customer_address","supplier_ship_from_location","product","product_family","document"]},"readable":{"type":"boolean"},"version":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"parent":{"type":"object","properties":{"type":{"type":"string","enum":["customer","supplier","product","purchase_order"]},"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"}},"required":["type","id","displayName"],"additionalProperties":false},"matchReasons":{"type":"array","items":{"type":"string","enum":["name","email","externalId","address","code","product","url"]}},"readbackPath":{"type":"string"}},"required":["type","readable","matchReasons"],"additionalProperties":false}},"idempotency":{"type":"object","properties":{"required":{"type":"boolean"},"keyProvided":{"type":"boolean"},"wouldReplay":{"type":"boolean"}},"required":["required","keyProvided","wouldReplay"],"additionalProperties":false},"wouldChange":{"type":"object","properties":{"fieldNames":{"type":"array","items":{"type":"string"}},"values":{"type":"object","additionalProperties":{}}},"required":["fieldNames","values"],"additionalProperties":false},"impactAnalysis":{"type":"object","properties":{"asOf":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"currentEntry":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"entryType":{"type":"string","enum":["direct","constructed"]}},"required":["id","entryType"],"additionalProperties":false},"normalizedConstruction":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["direct"]},"basis":{"type":"string","enum":["material","landed"]},"uom":{"type":"string","enum":["GALLON","LITER","POUND","KILOGRAM","EACH","METRIC_TON","SHORT_TON"]},"costPerBaseUomCents":{"type":"string"},"rates":{"type":"array","items":{"type":"object","properties":{"costPerBaseUomCents":{"type":"string"},"minimumQuantity":{"type":["string","null"]},"minimumBasis":{"type":["string","null"],"enum":["product_uom","package"]},"minimumProductPackagingId":{"type":["string","null"],"format":"uuid"}},"required":["costPerBaseUomCents"],"additionalProperties":false},"minItems":1,"maxItems":50}},"required":["type","basis","uom"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["constructed"]},"startingCost":{"type":"object","properties":{"source":{"type":"string","enum":["entered"]},"basis":{"type":"string","enum":["material","landed"]},"uom":{"type":"string","enum":["GALLON","LITER","POUND","KILOGRAM","EACH","METRIC_TON","SHORT_TON"]},"costPerBaseUomCents":{"type":"string"}},"required":["source","basis","uom","costPerBaseUomCents"],"additionalProperties":false},"additionalCosts":{"type":"array","items":{"type":"object","properties":{"class":{"type":"string","enum":["FREIGHT","PACKAGING","DUTY","STORAGE","PROCESSING","HANDLING","TAX","OTHER"]},"method":{"type":"string","enum":["percent_of_starting_cost","cents_per_base_uom","cents_per_package"]},"value":{"type":"string"},"description":{"type":["string","null"],"maxLength":500}},"required":["class","method","value"],"additionalProperties":false},"minItems":1,"maxItems":50}},"required":["type","startingCost","additionalCosts"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["constructed"]},"startingCost":{"type":"object","properties":{"source":{"type":"string","enum":["cost_book_entry"]},"productId":{"type":"string","format":"uuid"}},"required":["source","productId"],"additionalProperties":false},"additionalCosts":{"type":"array","items":{"type":"object","properties":{"class":{"type":"string","enum":["FREIGHT","PACKAGING","DUTY","STORAGE","PROCESSING","HANDLING","TAX","OTHER"]},"method":{"type":"string","enum":["percent_of_starting_cost","cents_per_base_uom","cents_per_package"]},"value":{"type":"string"},"description":{"type":["string","null"],"maxLength":500}},"required":["class","method","value"],"additionalProperties":false},"maxItems":50}},"required":["type","startingCost","additionalCosts"],"additionalProperties":false}]},"baseCurrencyCode":{"type":"string"},"predictedEntry":{"type":["object","null"],"properties":{"entryType":{"type":"string","enum":["direct","constructed"]},"construction":{"type":"object","properties":{"type":{"type":"string","enum":["direct","constructed"]},"startingCost":{"type":"object","properties":{"source":{"type":"string","enum":["entered","cost_book_entry"]},"entryId":{"type":["string","null"],"format":"uuid"},"productId":{"type":["string","null"],"format":"uuid"},"basis":{"type":["string","null"],"enum":["material","landed"]},"amount":{"type":"object","properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string"},"uom":{"type":"string","enum":["GALLON","LITER","POUND","KILOGRAM","EACH","METRIC_TON","SHORT_TON"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom"],"additionalProperties":false}},"required":["source","entryId","productId","basis","amount"],"additionalProperties":false},"additionalCosts":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"integer","minimum":0},"class":{"type":"string","enum":["FREIGHT","PACKAGING","DUTY","STORAGE","PROCESSING","HANDLING","TAX","OTHER"]},"method":{"type":"string","enum":["percent_of_starting_cost","cents_per_base_uom","cents_per_package"]},"value":{"type":"string"},"description":{"type":["string","null"]},"resolvedContribution":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string"},"uom":{"type":"string","enum":["GALLON","LITER","POUND","KILOGRAM","EACH","METRIC_TON","SHORT_TON"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom"],"additionalProperties":false}},"required":["sequence","class","method","value","description","resolvedContribution"],"additionalProperties":false}}},"required":["type","startingCost","additionalCosts"],"additionalProperties":false},"additionalCostTotal":{"type":"object","properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string"},"uom":{"type":"string","enum":["GALLON","LITER","POUND","KILOGRAM","EACH","METRIC_TON","SHORT_TON"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom"],"additionalProperties":false},"totalCost":{"type":"object","properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string"},"uom":{"type":"string","enum":["GALLON","LITER","POUND","KILOGRAM","EACH","METRIC_TON","SHORT_TON"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom"],"additionalProperties":false},"completeness":{"type":"object","properties":{"status":{"type":"string","enum":["complete"]},"warningCodes":{"type":"array","items":{"type":"string"}}},"required":["status","warningCodes"],"additionalProperties":false}},"required":["entryType","construction","additionalCostTotal","totalCost","completeness"],"additionalProperties":false},"costContext":{"type":["object","null"],"properties":{"product":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"code":{"type":"string"},"displayName":{"type":"string"},"baseUom":{"type":"string"},"archived":{"type":"boolean","enum":[false]}},"required":["id","code","displayName","baseUom","archived"],"additionalProperties":false},"supplier":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"archived":{"type":"boolean","enum":[false]}},"required":["id","displayName","archived"],"additionalProperties":false},"costBookAsOf":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"purchaseEvidenceObservedAt":{"type":"string","format":"date-time"},"currencyCode":{"type":"string","minLength":3,"maxLength":3},"currentCostBookEntry":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"entryType":{"type":"string","enum":["direct","constructed"]},"effectiveFrom":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"effectiveTo":{"type":["string","null"],"pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"cost":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string","minLength":3,"maxLength":3},"uom":{"type":"string"},"comparisonBasis":{"type":"string","enum":["material","landed","unclassified"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom","comparisonBasis"],"additionalProperties":false},"resolutionState":{"type":"string","enum":["resolved","quantity_required","unavailable"]},"completeness":{"type":"string","enum":["complete","unresolved"]},"warningCodes":{"type":"array","items":{"type":"string"}},"rates":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"integer","minimum":0},"amount":{"type":"object","properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string","minLength":3,"maxLength":3},"uom":{"type":"string","minLength":1}},"required":["decimalCentsPerBaseUom","currencyCode","uom"],"additionalProperties":false},"minimumQuantity":{"type":["string","null"]},"minimumBasis":{"type":["string","null"],"enum":["product_uom","package"]},"minimumPackage":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","minLength":1},"quantity":{"type":"string"},"uom":{"type":"string","minLength":1}},"required":["id","name","quantity","uom"],"additionalProperties":false}},"required":["sequence","amount","minimumQuantity","minimumBasis","minimumPackage"],"additionalProperties":false},"maxItems":50}},"required":["id","entryType","effectiveFrom","effectiveTo","cost","resolutionState","completeness","warningCodes","rates"],"additionalProperties":false},"priorCostBookEntry":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid"},"entryType":{"type":"string","enum":["direct","constructed"]},"effectiveFrom":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"effectiveTo":{"type":["string","null"],"pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"cost":{"type":["object","null"],"properties":{"decimalCentsPerBaseUom":{"type":"string"},"currencyCode":{"type":"string","minLength":3,"maxLength":3},"uom":{"type":"string"},"comparisonBasis":{"type":"string","enum":["material","landed","unclassified"]}},"required":["decimalCentsPerBaseUom","currencyCode","uom","comparisonBasis"],"additionalProperties":false},"resolutionState":{"type":"string","enum":["resolved","quantity_required","unavailable"]},"completeness":