Skip to main content

paginatedProductExternalIdentifiers

The external-system identifiers mapped to products (Amazon ASIN, Whole Foods UPC, etc.), paginated. With customerId alone it returns one customer's identifiers across the catalog, so the whole list can be read in pages.

Business Rules​

  • At least one of productId or customerId is required, so the list is always bounded by a product or a customer.
  • Only non-archived rows owned by the authenticated company are returned.
  • productFilters are the product list filters, applied before pagination.
  • Newest rows come first.

Error Scenarios​

  • **UNPROCESSABLE_CONTENT**: neither productId nor customerId was provided.
  • **NOT_FOUND**: the product does not belong to the active company.
  • **UNAUTHORIZED**: missing required permissions or invalid company access.

Permissions Required​

  • products:external_identifiers permission
paginatedProductExternalIdentifiers(
  after: String
  before: String
  customerId: ID
  first: Int
  last: Int
  productFilters: ProductFilterInput
  productId: ID
): ProductExternalIdentifierConnection!

Arguments​

paginatedProductExternalIdentifiers.after ● String scalar common​

Returns the elements in the list that come after the specified cursor.

paginatedProductExternalIdentifiers.before ● String scalar common​

Returns the elements in the list that come before the specified cursor.

paginatedProductExternalIdentifiers.customerId ● ID scalar common​

Limits the list to the identifiers linked to this customer.

paginatedProductExternalIdentifiers.first ● Int scalar common​

Returns the first _n_ elements from the list.

paginatedProductExternalIdentifiers.last ● Int scalar common​

Returns the last _n_ elements from the list.

paginatedProductExternalIdentifiers.productFilters ● ProductFilterInput input products​

Narrows the list to the products these filters match, before pagination. Accepts the same filters as the product list, so a screen can reuse them.

paginatedProductExternalIdentifiers.productId ● ID scalar common​

Limits the list to one product.

Type​

ProductExternalIdentifierConnection object common​

The connection type for ProductExternalIdentifier.