Can you use GraphQL to query using externalId?

Shopify CLI and Libraries
1

I would expect the following query to return the single Company Location where the externalId is set to “ABC123” however it returns all?

{
companyLocations(first: 3, query: “externalId:ABC123”) {
edges {
node {
id
name
externalId
}
}
}
}

2

Hi - you should be able to filter by externalId, can you try with straight quotes instead, ie: "externalId:ABC123"

3

Hey Liam,

I think that was just an artifact of copy and paste - below still returns 3 when only 1 Company Location has this specific ExternalID

{
companyLocations(first: 3, query: “externalId:ABC123”) {
edges {
node {
id
name
externalId
}
}
}
}

Edit: yeah when I copy and paste into here it likes to make the curly quote, I can confirm my postman request is using straight quotes.

4

Hi again,

I’ve asked our internal team about this - it could be a possible bug. If you try filtering with other other filters on the query field, do they work as expected?

644×683 38.7 KB

5

Yes, searching by name / id function as I would expect

6

Can you try using external_id instead of externalId?

7

Seems to do the trick, documentation probably needs to be updated ha. Appreciate your help and quick responses!