Fluent Commerce Logo
Docs
Sign In

Debugging ShippIt Connector issues

How-to Guide

Author:

Movyn John

Changed on:

13 Nov 2023

Key Points

  • This guide covers the common symptoms and associated steps to debug issues with the ShippIt Connector.
  • In most cases, if there is an issue, the most likely symptom is if Fluent Store shows the consignment entity status as FAILED.

Steps

Symptoms

Step arrow right iconWebhooks being successfully sent from the Fluent platform

Check if Fluent’s other integrations which are webhooks/events based are working fine. audits can be used to verify this.

Step arrow right iconCreateOrder webhook is being sent to ShippIt

Check if Fluent is sending the Create to Shippit. For this, you will need the ID and the ID which is facing this issue. Both of them can be queried by if the issue time window is known:

1query
2{
3    waves(first:100, createdOn:
4    {
5        from:"2023-07-14T23:19:13.445Z"
6        to:"2023-07-15T01:19:13.445Z"
7    })
8    {
9        edges
10        {
11            node
12            {
13                id
14                location
15                {
16                    id
17                }
18                createdOn
19            }
20        }
21    }
22}

Step arrow right iconQuery CarrierOrderReady event

Use the ID and ID to extract the logs as in the example query below. This example uses a ID of 7045729 and a ID of 104. In the API response returned, try to find the name  of `CarrierOrderReady` , which is a going out of Fluent to ShippIt. If the status is Success this indicates that the was successfully received by ShippIt.

1{{fluentApiHost}}/api/v4.1/event?context.entityId=7045729&context.entityType=WAVE&context.rootEntityId=104&context.rootEntityType=LOCATION

Step arrow right iconSearch API response for errors

Search the same API response from the previous step, for any occurrence of an error such as the one in the example below.

1{
2            "id": "02402ca0-22b1-11ee-98b5-e723274f2ed6",
3            "name": "CARRIER_GET_LABELS_RESPONSE",
4            "type": "ORCHESTRATION",
5            "accountId": "ABCDE",
6            "retailerId": "1",
7            "category": "ORDER WORKFLOW",
8            "context": {
9                "sourceEvents": [],
10                "entityType": "WAVE",
11                "entityId": "7045729",
12                "entityRef": "7045729",
13                "rootEntityType": "LOCATION",
14                "rootEntityId": "104",
15                "rootEntityRef": "2640"
16            },
17            "eventStatus": "COMPLETE",
18            "attributes": [
19                {
20                    "name": "fulfillments",
21                    "value": [
22                        {
23                            "ref": "7f8b8524-3f60-481f-aada-6062dc89216d",
24                            "articles": [
25                                {
26                                    "ref": "7f8b8524-3f60-481f-aada-6062dc89216d-2640-1",
27                                    "consignment": {
28                                        "ref": "87ea5ccd-e4f0-4b74-acac-8eec9f10dc27",
29                                        "errors": [
30                                            {
31                                                "code": "404",
32                                                "message": "The requested order could not be found.\n"
33                                            }
34                                        ],
35                                        "consignmentReference": "default-consignment-reference"
36                                    }
37                                }
38                            ]
39                        }
40                    ],
41                    "type": "STRING"
42                }
43            ],
44            "source": "Fluent-API",
45            "generatedBy": "Shippit Integration User",
46            "generatedOn": "2023-07-15T01:43:33.738+00:00"
47        }

Step arrow right iconNo error in ShippIt event audit logs

In most cases, Shippit responds with back with an error, unless the Shippit itself is down and therefore no is sent back to Fluent. If no is sent back into Fluent from ShippIt, then the symptoms will be different. Instead of a FAILED status, consignments could be stuck in a CARRIER_ORDER_READY status, which indicates that Fluent is waiting to hear back from Shippit.