/gs1/products

POST /api/gs1/products

Price: 10 credits

Resolve a GTIN to the company that licensed it and the product data the licensee published

How to use it

Use this to find out who really owns a barcode: the registry answers with the licensee company for every registered GTIN, which is the authoritative record no retail catalogue can give you. Product master data (`brand`, `description`, `image`, `net_content`) exists only where the licensee published it, so an empty `brand` on a 200 means the licence is registered and the product detail is not, never that the call failed. A GTIN the registry does not hold answers 412, including an ISBN, which GS1 records as administered separately for books; a number whose check digit is wrong answers 422 instead, so the two failures tell you whether to fix the input or give up.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• gtin string required — GS1 Global Trade Item Number: 8, 12, 13 or 14 digits (examples: "0038000138416", "3017620422003", "045496590475"; minLength: 8; maxLength: 14)

Response

• @type string (default: "Gs1Product")
• gtin string (default: "")
• brand string (default: "")
• description string (default: "")
• image string (default: "")
• language string (default: "")
• localizations array (default: [])
  • @type string (default: "Gs1ProductLocalization")
  • language string (default: "")
  • brand string (default: "")
  • description string (default: "")
  • image string (default: "")
• global_product_category string (default: "")
• net_content string (default: "")
• country_of_sale string (default: "")
• is_discontinued boolean (default: false)
• company object nullable
  • @type string (default: "Gs1Company")
  • name string (default: "")
  • address string (default: "")
  • website string (default: "")
  • city string (default: "")
  • country string (default: "")
  • license_key string (default: "")
  • license_type string (default: "")
  • gln string (default: "")
  • member_organization string (default: "")
  • updated_at string (default: "")

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — The entity was not found, or a precondition failed Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.