Shipping Fields API Access

Retired Boards Appdev Custom Storefronts
1

We are interested in exporting shipping data on an order level basis. Specifically, we are interested in the following details that are currently visible only through order timeline notes (where it says Someone purchased a shipping label and you click the dropdown and it shows these details):

  1. Box weight (the weight of the actual packed package, not the combined weight of the items in the package)
  2. Box size
  3. Carrier/Shipment Method (e.g UPS Ground Shipping)
  4. Shipping label cost- the amount we paid for the label through Shopify Shipping (not what the customer was charged)
  5. The amount customer paid for shipping–fact_shopify_orders provides this information
  6. Shipping insurance cost (what we paid for ShipSurance insurance through Shopify shipping)

We use a 3rd party analytics partner called Glew. Glew uses an API connection with Shopify and is not currently able to pull the above data.

We inspected the page to access the developers tools menu and we can see that the information we want (e.g. box size and weight) is a “class.” This is the same type of class as fields that are already available through the API connection (e.g. Subtotal). Our MSM suggested we reach out to Shopify’s Tech community here for further details regarding adding the desired custom fields. Please let us know if anyone can help! We would like to run various shipping analyses.

2

Hi @tessrwt

While I can’t give you a direct answer here - I’d suggest you start looking into “Events” either on orders or fulfilments.

Something like this GraphQL query should let you at least see whether or not those events (and if so - those details) are listed in the API response:

query {
  orders(first:10){
    nodes {
      fulfillments(first:10){
        trackingInfo {
          company
          number
          url
        }
        service {
          id
        }
        estimatedDeliveryAt
        createdAt
        displayStatus
        events(first:10){
          nodes {
            happenedAt
            status
            __typename
          }
        }
      }
      events(first:10){
        nodes{
          appTitle
          id
          message
        }
      }
    }
  }
}

Hopefully that at least sends you in the right direction!

3

I was looking for the same thing. I have confirmed with Shopify that,

they are “not able to see any field that is available in the API that would report on that rate” and

that they “can confirm that there is no field on the order that holds this information.”

They recommend that I seek answers here.

Please let me know if you find out anything.

Thanks!

John

4

Unfortunately, we have not found any solutions within native Shopify. We are going to utilize a UPS Capital insurance API connection and will be able to review the desired information directly in our UPS account. Best of luck!

5

So they’re in the timeline but don’t appear anywhere at all in the API?

Do they not appear in order events?

Only other solution might be to run a pupeteer script on order update?

I would’ve thought anything in the timeline will appear in the API somewhere though?

6

:waving_hand:t4: You are correct that much of this information is not available through the API yet. We’re looking into understanding merchant and partner needs here better – would you be up for a call and a possible beta for this?