Shipments complete field list

GraphQL API
1

I cannot find in your documents the entire list of fields available from your API.

When I pull the shipments list in an Excel spreadsheet from the web portal, I get a list of fields that I cannot seem to find in the graphql.

Where can I find a complete list of the fields available in the Shipments table?

2

Hello @jfalk-APL!
Welcome to the ShipHero Public API Community!

If you use a GraphQL client like Altair, you will access the whole schema.

In the schema, you can see every available call plus or the available fields in each of them.

What are you looking for? shipment query o shipment_create mutation?

Have a nice day!
TomasFD

3

I am trying to get the same fields that a user can get when they pull the email of shipments report from the shipments portal. My goal is to automate that pull rather than having to go manually grab the report,.

4

Hello @jfalk-APL!

There is no way to pull that same report from the public-API at the moment.

You need to either

  1. Use the shipments mutation and paginate through them. You can filter using date_from and date_to.
query{
  shipments(date_from:"ISODateTime" date_to:"ISODateTime"){
    data{
      edges{
        node{
          #fields
        }
      }
    }
  }
}
  1. Use the Shipment Update webhook to get each shipment in real-time as they get created: Webhooks – Developer Resources | ShipHero

Have a great day!
TomasFD