Retrieve Order Shipment Information

Hi,

I was looking for the possibility to retrieve order shipment information, such as tracking code and carrier, from Veeqo.

After checking API documentation I could not find shipment information in the order detail response body (https://developer.veeqo.com/docs#/reference/orders/order/view-an-order-detail). Neither the retrieval is supported via shipment endpoints.

Does anyone know if there is away to pull order shipment data?

Hey @Rugile :wave:

On shipped orders you can can find the shipments information under the allocations[].shipment part of the response. In the allocations key you should see many allocations, with shipped ones containing shipment details.

(In Veeqo, the allocations have a one-to-one association with shipments)

I can see it isn’t clear in that section of the docs right now so we’ll look to make this more clear and add examples.

1 Like

Great! Thanks for a quick response.

I am looking for this to but can’t find it. Could you help me please where to find the shipping details (tracking number, shipping carrier, …)?

Hi Rugile,

Are you trying this out on Magento 1 by any chance?

If so we are looking for this exact solution, perhaps we could connect?

Hi,

We’re currently waiting for OAuth creds but in the mean time, I’m yet to find any example json data for order.allocations.shipment.

Could you please send me an example? I’ve asked this before but for the sake of sanity could you please tell me, when a user clicks “shipped” this is logged on the shipment object? I.E the userId of the action.

Any examples would be extremely helpful.

Regards,

Hiya @RetainMeDevs

You should have your OAuth creds by email now, please let me know if these haven’t arrived.

I’ve managed to generate a JSON response in Insomnia from my test account, is that what you’re looking for?

Cheers
Laura

Hi Laura,

Thank you very much I’ve received those and replied.

Ideally looking for the shipment object in which is assigned to an allocation… looking at the above thread.

Regards,

Hi Again

So I think this is what you’re after but please let me know if I haven’t fully understood.

Here’s an example response from a GET request to https://api.veeqo.com/orders/order_id

"allocations": [
    {
      "id": 60816145,
      "updated_at": "2021-01-19T14:09:25.819Z",
      "created_at": "2021-01-19T14:04:50.432Z",
      "total_weight": 10,
      "weight_unit": "g",
      "allocated_by_id": 38140,
      "order_id": 74168067,
      "packed_completely": null,
      "due_date": null,
      "dispatch_date": null,
      "line_items": [
        {
          "id": 93922903,
          "quantity": 1,
          "picked_quantity": 0,
          "created_at": "2021-01-19T14:04:50.446Z",
          "updated_at": "2021-01-19T14:04:50.446Z",
          "sellable": {
            "allocated_stock_level_at_all_warehouses": 1,
            "id": 48636219,
            "type": "ProductVariant",
            "title": "",
            "sku_code": "P-123456782",
            "upc_code": "123456789",
            "model_number": "",
            "price": 12.0,
            "cost_price": 10.0,
            "min_reorder_level": 0,
            "quantity_to_reorder": 0,
            "created_by_id": 38140,
            "created_at": "2021-01-19T12:34:12.130Z",
            "updated_at": "2021-01-19T15:52:21.968Z",
            "weight_grams": 10.0,
            "weight_unit": "g",
            "product_title": "Stuffed Turkey Hat",
            "full_title": "Stuffed Turkey Hat",
            "sellable_title": "",
            "profit": 2.0,
            "margin": 16.67,
            "tax_rate": 20.0,
            "estimated_delivery": null,
            "product": {
              "id": 24500126,
              "title": "Stuffed Turkey Hat",
              "weight": 0,
              "origin_country": "GB",
              "hs_tariff_number": "",
              "tax_rate": 0,
              "estimated_delivery": null,
              "deleted_at": null,
              "deleted_by_id": null,
              "description": "A comical turkey hat",
              "main_image_src": "https://thumbnails.veeqo.com/UJAUSbmnLBrDIdJfk1zgAJiCr6cnG01oDal430kmUqk/rs:fit:1000:1000/aHR0cHM6Ly92ZWVx/by1wcm9kdWN0aW9u/LXN0b3JhZ2UuczMu/YW1hem9uYXdzLmNv/bS9pbWFnZXMvMTEy/ODY4NzExL3N0dWZm/ZWQtdHVya2V5LWhh/dF85MDB4X29yaWdp/bmFsLmpwZz8xNjEx/MDU5NjUz"
            },
            "reorders": [
              {
                "id": 1352554,
                "sellable_id": 48636219,
                "warehouse_id": 45669,
                "min_reorder_level": 0,
                "quantity_to_reorder": 0,
                "max_reorder_level": 0
              }
            ],
            "stock_entries": [
              {
                "sellable_id": 48636219,
                "warehouse_id": 45595,
                "infinite": false,
                "allocated_stock_level": 1,
                "stock_running_low": false,
                "updated_at": "2021-01-19T15:29:08.809Z",
                "incoming_stock_level": 0,
                "transit_outgoing_stock_level": 0,
                "warehouse": {
                  "id": 45595,
                  "name": "My Warehouse",
                  "display_position": 9999
                },
                "physical_stock_level": 3,
                "available_stock_level": 2,
                "sellable_on_hand_value": 30.0,
                "transit_incoming_stock_level": 0,
                "location": null
              },
              {
                "sellable_id": 48636219,
                "warehouse_id": 45669,
                "infinite": true,
                "allocated_stock_level": 0,
                "stock_running_low": false,
                "updated_at": "2021-01-19T15:52:21.946Z",
                "incoming_stock_level": 0,
                "transit_outgoing_stock_level": 0,
                "warehouse": {
                  "id": 45669,
                  "name": "New Warehouse",
                  "display_position": 9999
                },
                "physical_stock_level": null,
                "available_stock_level": null,
                "sellable_on_hand_value": null,
                "transit_incoming_stock_level": 0,
                "location": null
              }
            ],
            "variant_option_specifics": [],
            "variant_property_specifics": [],
            "images": [],
            "measurement_attributes": {
              "id": 49834338,
              "width": 10.0,
              "height": 10.0,
              "depth": 10.0,
              "dimensions_unit": "cm"
            },
            "available_stock_level_at_all_warehouses": null,
            "stock_level_at_all_warehouses": null,
            "inventory": {
              "infinite": true,
              "physical_stock_level_at_all_warehouses": null,
              "allocated_stock_level_at_all_warehouses": 1,
              "available_stock_level_at_all_warehouses": null,
              "incoming_stock_level_at_all_warehouses": 0,
              "transit_outgoing_stock_level_at_all_warehouses": 0,
              "transit_incoming_stock_level_at_all_warehouses": 0
            },
            "weight": 10.0
          }
        }
      ],
      "recommended_shipping_options": null,
      "matched_parcel_properties_criteria": null,
      "shipment": {
        "id": 56395885,
        "updated_at": "2021-01-19T14:09:25.544Z",
        "created_at": "2021-01-19T14:09:25.544Z",
        "allocation_id": 60816145,
        "carrier_id": 1,
        "shipped_by_id": 38140,
        "parcel_format": null,
        "postal_class": null,
        "weight": 10,
        "collection_manifest_id": null,
        "carrier_service_id": null,
        "service_type": null,
        "packaging_type": null,
        "drop_off_type": null,
        "label_url": null,
        "commercial_invoice_url": null,
        "insured_value": 0.0,
        "notify_customer": true,
        "update_remote_order": null,
        "delivery_confirmation_number": null,
        "tracking_url": null,
        "aftership_url": null,
        "tracking_number": null,
        "order_id": 74168067,
        "carrier": {
          "id": 1,
          "created_at": "2013-03-14T10:01:30.013Z",
          "updated_at": "2015-04-21T09:06:54.693Z",
          "provider_type": null,
          "slug": "royal-mail",
          "name": "Royal Mail",
          "is_configured?": false,
          "is_integrated?": true,
          "is_demo_mode?": false,
          "show_when_shipping?": true,
          "inbound_supported": false
        },
        "carrier_service": null,
        "carrier_country": null,
        "carrier_fees": [],
        "carrier_fee": null,
        "shipped_by": {
          "id": 38140,
          "login": "Laura Harvey",
          "email": "laura@veeqo.com"
        }
      },

Hi Laura,

That looks great, thank you.

I can see “shipped_by” (at the bottom) and that most certainly looks like what I’m after. Out of curiosity, did you click “ship” in the veeqo app?

Regards,

Hiya,

Yes, this has been “shipped” through the veeqo app!

Cheers
Laura

1 Like

Good Morning Laura,

That’s awesome! Thank you very much for your time. It is very much appreciated.

Stay Safe,

1 Like