Debugging ShippIt Connector issues
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
Webhooks being successfully sent from the Fluent platform
Check if Fluent’s other integrations which are webhooks/events based are working fine. Event audits can be used to verify this.
CreateOrder webhook is being sent to ShippIt
Check if Fluent is sending the Create Order webhook to Shippit. For this, you will need the Wave ID and the Location ID which is facing this issue. Both of them can be queried by GraphQL 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}Language: json
Name: Query for waves during affected time period
Description:
[Warning: empty required content area]Query CarrierOrderReady event
Use the Wave ID and Location ID to extract the event logs as in the example query below. This example uses a Wave ID of 7045729 and a Location ID of 104. In the API response returned, try to find the event name of
`CarrierOrderReady`1{{fluentApiHost}}/api/v4.1/event?context.entityId=7045729&context.entityType=WAVE&context.rootEntityId=104&context.rootEntityType=LOCATIONLanguage: json
Name: Event query for wave and location
Description:
[Warning: empty required content area]Search 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 }Language: json
Name: ShippIt event audit error
Description:
[Warning: empty required content area]No error in ShippIt event audit logs
In most cases, Shippit responds with back with an error, unless the Shippit Connector itself is down and therefore no event is sent back to Fluent. If no event is sent back into Fluent from ShippIt, then the symptoms will be different. Instead of a FAILED consignment entity status, consignments could be stuck in a CARRIER_ORDER_READY status, which indicates that Fluent is waiting to hear back from Shippit.
