{"id":"gtin-hierarchy","title":"GTIN hierarchy: GTIN-8/12/13/14 forms, GS1 prefix, packaging-level link","description":"Takes up to 100 GTINs and, for an agent reconciling a product feed or order lines, validates each check digit, converts it to the 14-digit form, reads the indicator digit and GS1 Prefix (restricted-circulation, ISBN/ISSN range, coupon), and, when a parent GTIN is given, checks the two share one base item (the packaging-level link). It does not look up the brand owner, the product or the country of the issuing GS1 organisation, and does not check that a GTIN is registered.","roi":"Stops case and each-level GTINs being mixed up in a feed, and flags in-store (restricted) numbers before they leak into a marketplace listing.","audience":"business","package":"identifier-text-kit","channels":["x402","mcp"],"endpoint":{"method":"POST","url":"https://agents.writerslogic.com/api/v1/gtin-hierarchy","path":"/api/v1/gtin-hierarchy","contentType":"application/json"},"price":{"amount":"0.005","currency":"USDC","network":"base","perCall":true,"failedCallsCharged":false},"inputSchema":{"type":"object","additionalProperties":false,"required":["items"],"properties":{"items":{"type":"array","minItems":1,"maxItems":100,"items":{"type":"object","required":["gtin"],"properties":{"gtin":{"type":"string","minLength":1,"maxLength":32},"parent":{"type":"string","maxLength":32,"description":"Another GTIN that should be a packaging level of the same base item (for example the case GTIN-14 of a consumer unit)."}}}}}},"resultSchema":{"type":"object","properties":{"status":{"type":"string","enum":["pass","fail","unknown","unsupported"],"description":"pass: every rule held. fail: a rule was violated (see witnesses). unknown: the input lacks the evidence to decide. unsupported: outside what this engine covers. Missing evidence is never a pass."},"results":{"type":"array","items":{"type":"object","properties":{"index":{"type":"integer"},"gtin":{"type":"string"},"status":{"type":"string","enum":["pass","fail","unknown","unsupported"]},"gtinType":{"anyOf":[{"type":"string","enum":["GTIN-8","GTIN-12","GTIN-13","GTIN-14"]},{"type":"null"}]},"gtin14":{"anyOf":[{"type":"string","description":"Zero-padded 14-digit form."},{"type":"null"}]},"indicatorDigit":{"anyOf":[{"type":"string","description":"Only for a 14-digit input."},{"type":"null"}]},"indicatorMeaning":{"anyOf":[{"type":"string"},{"type":"null"}]},"baseItemGtin13":{"anyOf":[{"type":"string","description":"The GTIN-13 of the base item: item reference digits 2-13 of the GTIN-14 form with a recomputed check digit."},{"type":"null"}]},"upcA":{"anyOf":[{"type":"string","description":"The 12-digit U.P.C.-A form when the number has one."},{"type":"null"}]},"gs1Prefix":{"anyOf":[{"type":"object","properties":{"prefix":{"type":"string"},"scope":{"type":"string","enum":["global","restricted","other-agency","reserved"]},"significance":{"type":"string"}}},{"type":"null"}]},"checkDigit":{"anyOf":[{"type":"object","properties":{"expected":{"type":"string"},"actual":{"type":"string"}}},{"type":"null"}]},"relation":{"anyOf":[{"type":"object","properties":{"parent":{"type":"string"},"sameBaseItem":{"type":"boolean"},"parentIndicator":{"anyOf":[{"type":"string"},{"type":"null"}]}}},{"type":"null"}]}}}},"counts":{"type":"object","description":"Items per status.","properties":{"pass":{"type":"integer"},"fail":{"type":"integer"},"unknown":{"type":"integer"},"unsupported":{"type":"integer"}}},"witnesses":{"type":"array","items":{"type":"object","properties":{"ruleId":{"type":"string"},"detail":{"type":"string"},"path":{"type":"string","description":"JSON pointer or dotted path into the input."},"offset":{"type":"integer"},"index":{"type":"integer"},"expected":{"description":"What the rule required."},"actual":{"description":"What the input had."}}}},"versions":{"type":"object","description":"Every semantic dependency of this answer (engine, tables and their as-of dates, tokenizer, calendar, rounding profile)."},"limits":{"type":"array","items":{"type":"string"}},"deterministic":{"type":"boolean","description":"Always true: pure code, no model."}}},"outputSchema":{"type":"object","properties":{"data":{"type":"object","properties":{"status":{"type":"string","enum":["pass","fail","unknown","unsupported"],"description":"pass: every rule held. fail: a rule was violated (see witnesses). unknown: the input lacks the evidence to decide. unsupported: outside what this engine covers. Missing evidence is never a pass."},"results":{"type":"array","items":{"type":"object","properties":{"index":{"type":"integer"},"gtin":{"type":"string"},"status":{"type":"string","enum":["pass","fail","unknown","unsupported"]},"gtinType":{"anyOf":[{"type":"string","enum":["GTIN-8","GTIN-12","GTIN-13","GTIN-14"]},{"type":"null"}]},"gtin14":{"anyOf":[{"type":"string","description":"Zero-padded 14-digit form."},{"type":"null"}]},"indicatorDigit":{"anyOf":[{"type":"string","description":"Only for a 14-digit input."},{"type":"null"}]},"indicatorMeaning":{"anyOf":[{"type":"string"},{"type":"null"}]},"baseItemGtin13":{"anyOf":[{"type":"string","description":"The GTIN-13 of the base item: item reference digits 2-13 of the GTIN-14 form with a recomputed check digit."},{"type":"null"}]},"upcA":{"anyOf":[{"type":"string","description":"The 12-digit U.P.C.-A form when the number has one."},{"type":"null"}]},"gs1Prefix":{"anyOf":[{"type":"object","properties":{"prefix":{"type":"string"},"scope":{"type":"string","enum":["global","restricted","other-agency","reserved"]},"significance":{"type":"string"}}},{"type":"null"}]},"checkDigit":{"anyOf":[{"type":"object","properties":{"expected":{"type":"string"},"actual":{"type":"string"}}},{"type":"null"}]},"relation":{"anyOf":[{"type":"object","properties":{"parent":{"type":"string"},"sameBaseItem":{"type":"boolean"},"parentIndicator":{"anyOf":[{"type":"string"},{"type":"null"}]}}},{"type":"null"}]}}}},"counts":{"type":"object","description":"Items per status.","properties":{"pass":{"type":"integer"},"fail":{"type":"integer"},"unknown":{"type":"integer"},"unsupported":{"type":"integer"}}},"witnesses":{"type":"array","items":{"type":"object","properties":{"ruleId":{"type":"string"},"detail":{"type":"string"},"path":{"type":"string","description":"JSON pointer or dotted path into the input."},"offset":{"type":"integer"},"index":{"type":"integer"},"expected":{"description":"What the rule required."},"actual":{"description":"What the input had."}}}},"versions":{"type":"object","description":"Every semantic dependency of this answer (engine, tables and their as-of dates, tokenizer, calendar, rounding profile)."},"limits":{"type":"array","items":{"type":"string"}},"deterministic":{"type":"boolean","description":"Always true: pure code, no model."}}},"_provenance":{"type":"object","description":"C2PA-aligned manifest and W3C VC 2.0 (eddsa-jcs-2022) issued by the hub DID; verify at POST /api/v1/verify-provenance"}},"required":["data","_provenance"]},"example":{"items":[{"gtin":"6291041500213"},{"gtin":"16291041500210","parent":"6291041500213"},{"gtin":"6291041500214"}]},"openapiOperation":{"operationId":"gtin_hierarchy","summary":"GTIN hierarchy: GTIN-8/12/13/14 forms, GS1 prefix, packaging-level link","description":"Takes up to 100 GTINs and, for an agent reconciling a product feed or order lines, validates each check digit, converts it to the 14-digit form, reads the indicator digit and GS1 Prefix (restricted-circulation, ISBN/ISSN range, coupon), and, when a parent GTIN is given, checks the two share one base item (the packaging-level link). It does not look up the brand owner, the product or the country of the issuing GS1 organisation, and does not check that a GTIN is registered.\n\nPrice: 0.005 USDC on Base (x402).","x-x402-price-usdc":"0.005","x-x402-amount":"5000","x-payment-info":{"protocols":["x402"],"price":{"mode":"fixed","currency":"USD","amount":"0.005"}},"x-audience":"business","x-sample-url":"https://agents.writerslogic.com/api/v1/samples/gtin-hierarchy","security":[{"x402":[]},{"apiKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["items"],"properties":{"items":{"type":"array","minItems":1,"maxItems":100,"items":{"type":"object","required":["gtin"],"properties":{"gtin":{"type":"string","minLength":1,"maxLength":32},"parent":{"type":"string","maxLength":32,"description":"Another GTIN that should be a packaging level of the same base item (for example the case GTIN-14 of a consumer unit)."}}}}}},"example":{"items":[{"gtin":"6291041500213"},{"gtin":"16291041500210","parent":"6291041500213"},{"gtin":"6291041500214"}]}}}},"responses":{"200":{"description":"Paid result with provenance","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"status":{"type":"string","enum":["pass","fail","unknown","unsupported"],"description":"pass: every rule held. fail: a rule was violated (see witnesses). unknown: the input lacks the evidence to decide. unsupported: outside what this engine covers. Missing evidence is never a pass."},"results":{"type":"array","items":{"type":"object","properties":{"index":{"type":"integer"},"gtin":{"type":"string"},"status":{"type":"string","enum":["pass","fail","unknown","unsupported"]},"gtinType":{"anyOf":[{"type":"string","enum":["GTIN-8","GTIN-12","GTIN-13","GTIN-14"]},{"type":"null"}]},"gtin14":{"anyOf":[{"type":"string","description":"Zero-padded 14-digit form."},{"type":"null"}]},"indicatorDigit":{"anyOf":[{"type":"string","description":"Only for a 14-digit input."},{"type":"null"}]},"indicatorMeaning":{"anyOf":[{"type":"string"},{"type":"null"}]},"baseItemGtin13":{"anyOf":[{"type":"string","description":"The GTIN-13 of the base item: item reference digits 2-13 of the GTIN-14 form with a recomputed check digit."},{"type":"null"}]},"upcA":{"anyOf":[{"type":"string","description":"The 12-digit U.P.C.-A form when the number has one."},{"type":"null"}]},"gs1Prefix":{"anyOf":[{"type":"object","properties":{"prefix":{"type":"string"},"scope":{"type":"string","enum":["global","restricted","other-agency","reserved"]},"significance":{"type":"string"}}},{"type":"null"}]},"checkDigit":{"anyOf":[{"type":"object","properties":{"expected":{"type":"string"},"actual":{"type":"string"}}},{"type":"null"}]},"relation":{"anyOf":[{"type":"object","properties":{"parent":{"type":"string"},"sameBaseItem":{"type":"boolean"},"parentIndicator":{"anyOf":[{"type":"string"},{"type":"null"}]}}},{"type":"null"}]}}}},"counts":{"type":"object","description":"Items per status.","properties":{"pass":{"type":"integer"},"fail":{"type":"integer"},"unknown":{"type":"integer"},"unsupported":{"type":"integer"}}},"witnesses":{"type":"array","items":{"type":"object","properties":{"ruleId":{"type":"string"},"detail":{"type":"string"},"path":{"type":"string","description":"JSON pointer or dotted path into the input."},"offset":{"type":"integer"},"index":{"type":"integer"},"expected":{"description":"What the rule required."},"actual":{"description":"What the input had."}}}},"versions":{"type":"object","description":"Every semantic dependency of this answer (engine, tables and their as-of dates, tokenizer, calendar, rounding profile)."},"limits":{"type":"array","items":{"type":"string"}},"deterministic":{"type":"boolean","description":"Always true: pure code, no model."}}},"_provenance":{"type":"object","description":"C2PA-aligned manifest and W3C VC 2.0 (eddsa-jcs-2022) issued by the hub DID; verify at POST /api/v1/verify-provenance"}},"required":["data","_provenance"]}}}},"400":{"description":"Invalid request (no payment consumed)","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string"}}}}}},"401":{"description":"Invalid X-API-KEY","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string"}}}}}},"402":{"description":"Payment required or invalid","content":{"application/json":{"schema":{"type":"object","description":"x402 v2 PaymentRequired (also base64 in the PAYMENT-REQUIRED header)","properties":{"x402Version":{"type":"integer"},"error":{"type":"string"},"code":{"type":"string"},"resource":{"type":"object"},"accepts":{"type":"array","items":{"type":"object"}},"extensions":{"type":"object"}}}}}},"502":{"description":"Upstream failure; the payment is released or not settled","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string"}}}}}}}},"links":{"docs":"https://agents.writerslogic.com/docs/gtin-hierarchy/","docsJson":"https://agents.writerslogic.com/docs/gtin-hierarchy.json","sample":"https://agents.writerslogic.com/api/v1/samples/gtin-hierarchy","openapi":"https://agents.writerslogic.com/openapi.json","catalog":"https://agents.writerslogic.com/api/v1/catalog","verifyProvenance":"https://agents.writerslogic.com/api/v1/verify-provenance","index":"https://agents.writerslogic.com/docs/index.json"}}