Get order by legacy id

madhupatel · March 4, 2020, 5:35am

i need graph query for get order by legacy_id can you please provide me query for that.

tomasw · March 4, 2020, 11:22am

HI @madhupatel!
You can use the order query and pass the legacy_id as id.
For example, if the legacy_id was 117902188, the query would be something like:

query {
  order(id: "117902188") {
    request_id
    complexity
    data {
      id
      legacy_id
      order_number
      shop_name
      fulfillment_status
      order_date
      profile
      required_ship_date
      shipping_lines {
        carrier
        method
        price
      }
      shipping_address {
        first_name
        last_name
        address1
        address2
        city
        state
        state_code
        zip
        country
      }
      tags
      line_items(first: 2) {
        edges {
          node {
            id
            sku
            quantity
            product_name
            fulfillment_status
            quantity_allocated
            backorder_quantity
            barcode
          }
          cursor
        }
      }
      shipments {
        id
        order_id
        user_id
        warehouse_id
        address {
          name
          address1
          address2
          city
          state
          country
          zip
        }
        shipped_off_shiphero
        dropshipment
      }
      returns {
        id
        reason
        status
      }
    }
  }
}

You can also check for the id of that order using the uuid query, for example:

query {
  uuid(legacy_id: 117902188, entity: Order) {
    request_id
    complexity
    data {
      legacy_id
      id
    }
  }
}

madhupatel · March 18, 2020, 7:09pm

hello team i need graph ql query for filter my order based on their tags .can you please share query for it.thanks in advance.

jrtwynam · April 16, 2020, 4:19pm

Is there a way to get order details based on the order number instead of either of the IDs? We have an automation rule in ShipHero that sends us an email when an order is placed, and the only information it sends is the order number (which seems to be hard-coded in the Email action - I don’t see a way to get the email to include any more info).

jrtwynam · April 16, 2020, 4:22pm

I tried using the uuid query shown above, like this:

{"query":"query { uuid(order_number: 407, entity: Order) { request_id complexity data { legacy_id id order_number } } }"}

But it didn’t like the fact that I passed it an order number instead of an ID:

Exception in Task: Unhandled errors
{"errors":[{"message":"Unknown argument \"order_number\" on field \"uuid\" of type \"Query\".","locations":[{"line":1,"column":16}]},{"message":"Cannot query field \"order_number\" on type \"LegacyId\".","locations":[{"line":1,"column":124}]},{"message":"Field \"uuid\" argument \"legacy_id\" of type \"Int!\" is required but not provided.","locations":[{"line":1,"column":11}]}]}Error getting HTTP response: The remote server returned an error: (400) Bad Request.

tomasw · April 17, 2020, 12:54pm

Hi @jrtwynam

You could use the orders query, filter by order number and get the first result, this is for example:

query {
  orders(order_number: "MO801") {
    request_id
    complexity
    data(first: 1) {
      edges {
        node {
          id
          legacy_id
          order_number
          shop_name
          fulfillment_status
          order_date
          email
          profile
        }
      }
    }
  }
}

And as for the Error, it looks like the same we are discussing on Issue updating products
But the UUID will only work to make the request using the legacy_id, which is the id of the order on ShipHero and it won’t work with the order number.
Let me know if that doesn’t work for you,
Thanks!

jrtwynam · April 17, 2020, 1:18pm

I just tried that, with the only change being to the order number in the criteria (and removing the newlines). It still gave me a bad request error.

jrtwynam · April 18, 2020, 10:01pm

I got something working where it runs the Orders query based on the order_number, which pulls back the legacy ID. I then use that ID in the Order query to pull back the order details. What I’m wondering is how to tell what warehouse the order is allocated to. We have one that is allocated to our Primary warehouse (based on looking in the web UI at the order), but I don’t see anything in the resulting JSON from the Order query that tells me that.

jrtwynam · April 20, 2020, 4:54pm

Hi @tomasw,

Here’s the JSON request for the order details:

query {
  order(id: "<enter order ID here>") {
    request_id
    complexity
    data {
      id
      legacy_id
      order_number
      shop_name
      fulfillment_status
      order_date
      profile
      required_ship_date
      shipping_lines {
        carrier
        method
        price
      }
      shipping_address {
        first_name
        last_name
        address1
        address2
        city
        state
        state_code
        zip
        country
      }
      tags
      line_items(first: 2) {
        edges {
          node {
            id
            sku
            quantity
            product_name
            fulfillment_status
            quantity_allocated
            backorder_quantity
            barcode
          }
          cursor
        }
      }
      shipments {
        id
        order_id
        user_id
        warehouse_id
        address {
          name
          address1
          address2
          city
          state
          country
          zip
        }
        shipped_off_shiphero
        dropshipment
      }
      returns {
        id
        reason
        status
      }
    }
  }
}

Here’s the JSON that came back from the above request. I don’t see anything that tells me which warehouse(s) the order was allocated to. Ideally, an order should be entirely allocated to a single warehouse, but we came across a situation a few days ago where an order was partially allocated to both of our warehouses. In that situation, I’d need to know where each order line is allocated.

{
  "data": {
    "order": {
      "request_id": "5e9dcfe6459b5d25d5e268be",
      "complexity": 3,
      "data": {
        "id": "T3JkZXI6MTIzMzY2Njcw",
        "legacy_id": 123366670,
        "order_number": "414",
        "shop_name": "<snip>",
        "fulfillment_status": "pending",
        "order_date": "2020-04-20T12:00:45-04:00",
        "profile": "default",
        "required_ship_date": "2020-04-21T20:00:00-04:00",
        "shipping_lines": {
          "carrier": "purolator",
          "method": "PurolatorGroundUS",
          "price": null
        },
        "shipping_address": {
          "first_name": "<snip>",
          "last_name": null,
          "address1": "<snip>",
          "address2": null,
          "city": "<snip>",
          "state": "<snip>",
          "state_code": null,
          "zip": "<snip>",
          "country": "US"
        },
        "tags": null,
        "line_items": {
          "edges": [
            {
              "node": {
                "id": "TGluZUl0ZW06MzYyNDY0ODY0",
                "sku": "70824420-FEL-10424-CS9284",
                "quantity": 1,
                "product_name": "Engine Conversion Gasket Set-VIN: B, CNG Fel-Pro CS 9284",
                "fulfillment_status": "pending",
                "quantity_allocated": 1,
                "backorder_quantity": 0,
                "barcode": null
              },
              "cursor": "YXJyYXljb25uZWN0aW9uOjA="
            }
          ]
        },
        "shipments": [],
        "returns": []
      }
    }
  }
}

I tried adding something like this to the request JSON:

query {
  order(id: "{JOB(Active|Variable|Legacy Order ID)}") {
    request_id
    complexity
    data {
      id
      legacy_id
      order_number
      shop_name
      fulfillment_status
      order_date
      profile
      required_ship_date
			*account {*

```
  			data {*
```
```
  				warehouses  {*
```
```
  					id*
```
```
  					legacy_id*
```
```
  					identifier*
```
```
  				}*
```
```
  			}*
```

  		}*
    shipping_lines {
      carrier
      method
      price
    }
    shipping_address {
      first_name
      last_name
      address1
      address2
      city
      state
      state_code
      zip
      country
    }
    tags
    line_items(first: 2) {
      edges {
        node {
          id
          sku
          quantity
          product_name
          fulfillment_status
          quantity_allocated
          backorder_quantity
          barcode
        }
        cursor
      }
    }
    shipments {
      id
      order_id
      user_id
      warehouse_id
      address {
        name
        address1
        address2
        city
        state
        country
        zip
      }
      shipped_off_shiphero
      dropshipment
    }
    returns {
      id
      reason
      status
    }
  }
}

}

But that request failed.

jrtwynam · April 22, 2020, 2:41pm

I figured it out. Although I haven’t found an all-inclusive list of the fields available to pull back in a query, I did find that Altair would suggest fields if you start typing. In my case, what I wanted was “warehouse”:

jrtwynam · April 28, 2020, 12:51pm

@tomasw, I thought I had figured it out, but it’s not returning the right data. It does return the order details, and the warehouse field “works” in the sense that it doesn’t give an error and does return a warehouse, but it’s not returning the warehouse that the order is allocated to. Here’s the JSON returned by the order query:

  {
  "data": {
    "order": {
      "request_id": "5ea7a25b66ff0261dc78dcf4",
      "complexity": 101,
      "data": {
        "id": "T3JkZXI6MTI0NTEyOTI3",
        "legacy_id": 124512927,
        "order_number": "425",
        "shop_name": "<snip>",
        "fulfillment_status": "pending",
        "order_date": "2020-04-27T23:03:52-04:00",
        "profile": "default",
        "required_ship_date": "2020-04-28T20:00:00-04:00",
        "shipping_lines": {
          "carrier": "purolator",
          "method": "PurolatorGroundUS",
          "price": null
        },
        "shipping_address": {
          "first_name": "<snip>",
          "last_name": null,
          "address1": "<snip>",
          "address2": null,
          "city": "<snip>",
          "state": "<snip>",
          "state_code": null,
          "zip": "<snip>",
          "country": "US"
        },
        "tags": null,
        "line_items": {
          "edges": [
            {
              "node": {
                "id": "TGluZUl0ZW06MzY0ODc1MzQ1",
                "sku": "75922791-AIR-15222-57398",
                "quantity": 1,
                "product_name": "Suspension Leveling Kit-FX4 Rear Air Lift 57398",
                "fulfillment_status": "pending",
                "quantity_allocated": 1,
                "backorder_quantity": 0,
                "barcode": null,
                "locked_to_warehouse_id": null,
                "warehouse": "Primary"
              },
              "cursor": "YXJyYXljb25uZWN0aW9uOjA="
            }
          ]
        },
        "shipments": [],
        "returns": []
      }
    }
  }
}

That data clearly says it’s warehouse “Primary”, but the ShipHero web UI clearly shows it’s not:

Any ideas?

Thanks.

tomasw · May 1, 2020, 12:23pm

Hi @jrtwynam
I just wanted to let you know that this is been looked at right now, I’ll try to provide a better insight as soon as possible.
I appreciate your patience on this!
Tom

originsid · May 1, 2020, 1:20pm

@tomasw I’ve noticed this as well so I’m glad it’s being looked into.

Nearly all of our line items are show “Primary” as the warehouse they’re assigned to, even though many of them are actually set to “ShipHero will assign” and they’re currently allocated to our second warehouse.

One line item I see in the data we sync from the GraphQL API does show that it’s assigned to our second warehouse, and when I look at that order in the dashboard I can see that the line item is locked to that second warehouse.

My hunch is that the API is returning which warehouse the line item is locked to, and if it’s not locked to a specific warehouse than it returns “Primary”, even if it’s currently allocated elsewhere.

Thank you!

-Sid

tomasw · May 2, 2020, 1:54pm

Hi @jrtwynam @originsid
I got to reproduce this and already submitted a ticket for this to be looked at.
I do believe it should be showing the warehouse where is allocated to, but I might be missing something here.
I will let you know as soon as I get a response on this.
Thanks!

jrtwynam · May 25, 2020, 4:58pm

Hi,

I’m just wondering if there’s any update to this. I’m still getting what appears to be incorrect data from the API regarding the warehouse.

Thanks.

tomasw · May 27, 2020, 1:48pm

Hi @jrtwynam
I apologize for the delay with this, I just raised priority so we can have a response about this.
I will provide an update as soon as this gets assigned.
Thanks again for your patience with this
Tom

madhupatel · June 1, 2020, 11:49am

hey @tomasw i’m facing issue when i’m creating order via graphql api .i’m getting error product with sku ‘zz_freight-small shpmt’ does not exist.
but when i try same details with rest api it’s not giving me any error and it’s successfully created.

tomasw · June 1, 2020, 12:48pm

Hi @madhupatel
Do you have the request_id of when you get that error?
Thanks in advance!,
Tom

madhupatel · June 1, 2020, 12:56pm

[request_id] => 5ed4ef858250959ecad4e520
this is my request id.

tomasw · June 1, 2020, 2:02pm

Hi @madhupatel
Thanks for the info!
Right, that is because those SKUs don’t exist in the account, so It wont let you create order for non-existing SKUs
You will need to create those products on your account to be able to create an order with those products on it
Let me know if I could explain better or if there is anything else I could help you with
Thanks again!
Tom

Topic		Replies	Views
Getting an external order_number with graphQL, in shipments query GraphQL API	1	408	July 24, 2020
Create Order doesn't return legacy ID GraphQL API	2	23	August 13, 2024
3PL Client Account \| Can't pull order by order_number GraphQL API	15	437	October 11, 2021
Using legacy_id from GraphQL to retrieve purchase orders via the legacy API GraphQL API	2	577	October 16, 2019
Where to find IDs? GraphQL API	10	2372	April 15, 2020

Get order by legacy id

Related topics