DOCS

Retrieve customs documentation

/

Récupérer la documentation douanière

Récupérez un ou plusieurs documents douaniers pour une ou plusieurs commandes.

GraphQL

Une fois qu'un customsSpec a été généré ou créé pour un envoi particulier, il peut être interrogé. Ces requêtes peuvent être utilisées par quiconque cherchant à récupérer un customsSpec basé sur id, dateTimeRange ou trackingNumber.

Récupérer un document unique

Fournissez les informations nécessaires pour récupérer un document douanier généré par Zonos.

Pour récupérer un customsSpec unique, un utilisateur peut interroger par l'ID du customsSpec qu'il souhaite retourner.

Requête

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
query CustomsSpec($id: ID!) {
  customsSpec(id: $id) {
    id
    deliveryDutyPaid
    declarationStatement
    amountSubtotals {
      duties
      fees
      insurance
      shipping
    }
    customsItems {
      items {
        id
      }
    }
  }
}

Variables

1
2
3
{
  "id": "customs_spec_66b544c9-439f-4a82-b5bb-1a00274e8a61"
}

Réponse

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
{
  "data": {
    "customsSpec": {
      "id": "customs_spec_66b544c9-439f-4a82-b5bb-1a00274e8a61",
      "declarationStatement": "I declare this is a declaration statement",
      "amountSubtotals": {
        "duties": 10.0,
        "fees": 5.0,
        "insurance": 10.0,
        "shipping": 15.99
      },
      "customsItems": [
        {
          "items": [
            {
              "id": "test_item_123"
            }
          ]
        }
      ]
    }
  }
}

Récupérer plusieurs documents

Fournir les informations nécessaires pour récupérer plusieurs documents douaniers générés par Zonos.

Dans les scénarios où un utilisateur souhaite récupérer plusieurs customsSpecs par DateTimeRange et trackingNumber, la requête suivante peut être utilisée.

Requête

1
2
3
4
5
6
7
8
9
10
11
12
13
14
query CustomsSpecs($first: Int, $filter: CustomsSpecFilter) {
  customsSpecs(first: $first, filter: $filter) {
    edges {
      node {
        id
        amountSubtotals {
          duties
          fees
          insurance
        }
      }
    }
  }
}

Variables

1
2
3
4
5
6
7
8
9
10
{
  "first": 5,
  "filter": {
    "between": {
      "before": "2022-09-25T12:00:00Z",
      "after": null
    },
    "trackingNumber": null
  }
}

Réponse

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
{
  "data": {
    "customsSpecs": {
      "edges": [
        {
          "node": {
            "id": "customs_spec_ee8eae49-64cd-440e-ac92-3cd90ce4be5b",
            "amountSubtotals": {
              "duties": 143.0,
              "fees": 2.0,
              "insurance": 100.0
            }
          }
        },
        {
          "node": {
            "id": "customs_spec_da0015aa-78cc-46c0-9006-bf25e0d7c57f",
            "amountSubtotals": {
              "duties": 143.0,
              "fees": 2.0,
              "insurance": 100.0
            }
          }
        },
        {
          "node": {
            "id": "customs_spec_8e8039f5-2e8c-4958-922f-f4dad0bc190f",
            "amountSubtotals": {
              "duties": 143.0,
              "fees": 2.0,
              "insurance": 100.0
            }
          }
        },
        {
          "node": {
            "id": "customs_spec_30e31150-13fe-423f-952a-13582454744a",
            "amountSubtotals": {
              "duties": 143.0,
              "fees": 2.0,
              "insurance": 100.0
            }
          }
        }
      ]
    }
  }
}

Récupérer les spécifications douanières

Les utilisateurs de l'API douanière de Zonos ont également la possibilité de récupérer une customsSpec basée sur le accountOrderNumber, DateTimeRange, l'id de commande et le storeId de Zonos. Dans ce scénario, un utilisateur interrogera les orders DGS au lieu de customsSpec.

Récupérer les documents pour les commandes

Récupérer les documents pour une commande
Récupérer des documents pour plusieurs commandes

Fournir les informations nécessaires pour récupérer la documentation douanière générée par Zonos pour une seule commande.

Pour récupérer une seule customsSpec, un utilisateur peut interroger par l'ID de la commande liée à la customsSpec.

Requête

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
query OrderQuery($id: String!) {
  order(orderId: $id) {
    id
    customsSpecs {
      id
      amountSubtotals {
        taxes
        shipping
        duties
        fees
        insurance
        items
      }
      clearanceType
      currency
    }
  }
}

Variables

1
2
3
{
  "id": "order_ad8dfd1f-5776-425f-8e4d-a0bd4e7d86e3"
}

Réponse

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
{
  "data": {
    "order": {
      "id": "order_ad8dfd1f-5776-425f-8e4d-a0bd4e7d86e3",
      "customsSpecs": [
        {
          "id": "customs_spec_6a4aed06-5303-4e83-965d-2accdb00b600",
          "amountSubtotals": {
            "taxes": 10.21,
            "shipping": 25.99,
            "duties": 143,
            "fees": 2,
            "insurance": 100,
            "items": 30.2
          },
          "clearanceType": "COMMERCIAL",
          "currency": "USD"
        },
        {
          "id": "customs_spec_dcbc618c-7480-4651-b59b-d634b0e68e9c",
          "amountSubtotals": {
            "taxes": 10.21,
            "shipping": 25.99,
            "duties": 143,
            "fees": 2,
            "insurance": 100,
            "items": 30.2
          },
          "clearanceType": "COMMERCIAL",
          "currency": "USD"
        }
      ]
    }
  }
}

Cette page était-elle utile?


Des questions ?

Contactez-nous.