Skip to main content

requestCompanyUpcsExport

Requests an asynchronous export of every UPC in one of the company's purchased GS1 blocks.

The export is processed in the background and generates a CSV with one row per code in the block — not only the codes with allocation history. An available code exists as an item reference with nothing recorded against it, so the block is walked by item reference and each code's status is derived.

Use the returned process_id to track progress; the finished file arrives as a notification.

Columns​

  • **UPC**: the full code including its check digit.
  • **STATUS**: Available (never assigned), In Use (carried by a product), or Retired (carried a product once and no longer does — out of the pool).
  • **LINKED_PRODUCT_ID**, **LINKED_SKU**, **LINKED_PRODUCT_NAME**: populated for In Use.

Size​

The whole block is exported regardless of exports_max_row_limit, which guards providers that load records rather than stream them. A licence caps capacity at a million codes, so the largest possible file is around 55MB; a truncated CSV would be worse, since nothing in one says it stopped early.

Authentication​

Requires a logged-in user with access to the company.

Possible Errors​

  • **You must be logged in**: Authentication is required.
  • **Company is required**: Company context must be provided (use X-Company-Id header).
  • **GS1 prefix not found**: The prefix does not belong to this company.
  • **GS1 prefix has no UPC block to export**: No GTIN capacity is recorded against it.
requestCompanyUpcsExport(
  input: RequestCompanyUpcsExportInput!
): AsynchronousActionResponse!

Arguments​

requestCompanyUpcsExport.input ● RequestCompanyUpcsExportInput! non-null input common​

Parameters for RequestCompanyUpcsExport

Type​

AsynchronousActionResponse object common​

Asynchronous action response type