/gs1/locations

POST /api/gs1/locations

Price: 10 credits

Resolve a GLN to the locations registered under it and the company that licensed it

How to use it

Turn a GLN from an EDI message, a despatch advice or a supplier master file into the party it identifies. One GLN can carry several records at once — a legal entity, a function, a physical site and a digital address all share the number — so read `locations` as a list and pick by `gln_type` rather than assuming one. `locations` is empty on a 200 when the number is licensed but no location detail was published; only `company` is filled then. A GLN that carries a GTIN licence rather than a location licence returns 412.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• gln string required — GS1 Global Location Number, 13 digits (examples: "0045496000004", "3010176200101", "0038000000003"; minLength: 13; maxLength: 13)

Response

• @type string (default: "Gs1LocationRecord")
• gln string (default: "")
• locations array (default: [])
  • @type string (default: "Gs1Location")
  • gln string (default: "")
  • gln_type string (default: "")
  • name string (default: "")
  • language string (default: "")
  • status string (default: "")
  • roles array (default: [])
  • parent_organization string (default: "")
  • related_locations string (default: "")
  • related_organizations string (default: "")
  • contained_in_place string (default: "")
  • additional_identifiers string (default: "")
  • postal_name string (default: "")
  • street_address string (default: "")
  • address_locality string (default: "")
  • postal_code string (default: "")
  • country_code string (default: "")
  • digital_address string (default: "")
  • email string (default: "")
  • telephone string (default: "")
  • website string (default: "")
  • available_languages array (default: [])
  • provided_by string (default: "")
  • updated_at string (default: "")
• 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.