Skip to main content

removeCompanyGs1Prefix

Removes an archived GS1 prefix and releases every owned code it still held.

The second half of a two-stage delete. Archiving retires a block: it stops issuing, but its codes stay recorded so Endless never hands them out again. Removing gives those codes up — Endless stops tracking them as owned, and another block may claim them.

Products keep their UPCs either way. Removing a block whose codes are on products leaves those products exactly as they were; it only ends Endless's claim to the codes, which is the state the company was in before the block was registered.

The usual reason to remove is that the block was never right — digits mistyped, or a range narrower than the licence. A corrected prefix always overlaps the mistake, so the mistake has to stop reserving codes before the correction can be registered.

SSCC serials are not released. The counter is keyed by the prefix digits rather than by this record, so re-registering the same digits continues where it left off.

Business Rules​

  • The prefix must exist within the current company.
  • It must already be archived. Archive first; this call will not do it for you.

Error Scenarios​

  • **NOT_FOUND**: when the prefix does not exist within the current company.
  • **BAD_REQUEST**: when the prefix is still live.

Permissions Required​

  • company:archive_gs1_prefix permission
removeCompanyGs1Prefix(
  input: RemoveCompanyGs1PrefixInput!
): RemoveCompanyGs1PrefixPayload

Arguments​

removeCompanyGs1Prefix.input ● RemoveCompanyGs1PrefixInput! non-null input common​

Parameters for RemoveCompanyGs1Prefix

Type​

RemoveCompanyGs1PrefixPayload object common​

Autogenerated return type of RemoveCompanyGs1Prefix.