ProductExternalIdentifier

A mapping of an EC product to how an external system (marketplace or EDI trading partner) identifies it — e.g. Amazon ASIN, Whole Foods UPC, Target TCIN.

type ProductExternalIdentifier {
  createdAt: ISO8601DateTime!
  customer: Customer
  customerId: ID
  externalId: String!
  id: ID!
  identifierType: String
  integrationId: ID
  integrationType: String
  linked: Boolean!
  partyName: String!
  productId: ID!
  updatedAt: ISO8601DateTime!
}

Fields

ProductExternalIdentifier.createdAt ● ISO8601DateTime! non-null scalar common

When the row was created.

ProductExternalIdentifier.customer ● Customer object common

The linked customer, if any.

ProductExternalIdentifier.customerId ● ID scalar common

The customer this row is linked to, if any ("what ID does this customer use for the product").

ProductExternalIdentifier.externalId ● String! non-null scalar common

The external system's value for this product.

ProductExternalIdentifier.id ● ID! non-null scalar common

Unique identifier for the mapping row.

ProductExternalIdentifier.identifierType ● String scalar common

The kind of identifier (e.g. ASIN, UPC, TCIN).

ProductExternalIdentifier.integrationId ● ID scalar common

The connected integration this row is linked to, if any.

ProductExternalIdentifier.integrationType ● String scalar common

The linked integration's type (e.g. endless_edi, amazon), set on link.

ProductExternalIdentifier.linked ● Boolean! non-null scalar common

Whether this row is linked to a connected integration or customer and therefore used for inbound/outbound operations.

ProductExternalIdentifier.partyName ● String! non-null scalar common

Free-text label for the external system. Canonicalized to the integration's name once linked.

ProductExternalIdentifier.productId ● ID! non-null scalar common

The EC product this identifier belongs to.

ProductExternalIdentifier.updatedAt ● ISO8601DateTime! non-null scalar common

When the row was last updated.

Returned By

productExternalIdentifiers query

Member Of

CreateProductExternalIdentifierPayload object ● Product object ● UpdateProductExternalIdentifierPayload object