DOCS

Integrate label api

/

Maak Zonos zendingen vanuit uw platform

Geef klanten de mogelijkheid om Zonos zendingen en labels vanuit uw platform te maken.

Als u een verzendplatform bent dat Zonos klanten ondersteunt bij internationale verzending, moet het integreren met Zonos voor het creëren van zendingen een topprioriteit zijn. Dit stelt u in staat om de meest naadloze ervaring voor uw handelaren en hun klanten te bieden door gebruik te maken van de bestaande functies van uw platform, terwijl Zonos het beheer van de creatie van de zending, het label en de ondersteunende douanedocumentatie op zich neemt.

Voordelen van het gebruik van Zonos voor het creëren van zendingen zijn onder andere:

  • Derde partij facturering van douanerechten en belastingen - Wij zorgen ervoor dat uw of de vervoersaccountnummer van uw handelaar wordt gebruikt voor verzendkosten, terwijl de rekeningen voor douane en belasting naar Zonos komen.
  • Flexibiliteit - In plaats van ontwikkelingswerk te verrichten om ervoor te zorgen dat u conforme labels met uw platform kunt genereren, integreert u met onze API en laat u de voortdurend veranderende grensoverschrijdende compliance aan ons over.
  • Nauwkeurige douanedocumentatie - Wanneer u Zonos gebruikt om labels te genereren, zorgen wij ervoor dat de juiste details aan de vervoerder worden doorgegeven, zodat het pakket snel door de douane komt.

Deze gids leidt u door de stappen om een complete end-to-end integratie te implementeren die u in staat stelt om Zonos voor zendingen vanuit uw platform aan te roepen.

Sta klanten toe om Zonos labels vanuit uw platform te printen 

Volg de onderstaande stappen om uw klanten in staat te stellen Zonos labels vanuit uw platform op te halen.

1

Sta klanten toe om hun Zonos API-gegevens in te voeren

De Zonos API is toegankelijk via een credentialToken. Uw platform moet klanten de mogelijkheid bieden om hun credentialToken van het Zonos Dashboard in uw platform in te voeren. Vanaf hier kunt u namens hen verzoeken indienen bij Zonos.

2

Maak een zending

Om een label op te halen, moet u een shipment creëren waarmee het label wordt geassocieerd. Zonos beheert dit proces met een workflow die shipments en labels in hetzelfde verzoek creëert. Bij het uitvoeren van deze mutatie hoeft u geen serviceLevel door te geven, aangezien wij het serviceLevel gebruiken dat is afgeleid van de landedCost die aan de order is gekoppeld. Voor de orderId kunt u de Zonos order ID of het accountOrderNumber gebruiken dat waarschijnlijk al in uw systeem staat. Wanneer een zending en labels succesvol zijn aangemaakt, zullen wij labels retourneren als een labelImage, wat een BASE64_ENCODED_IMAGE is, of als een url waar het label kan worden opgehaald.

Mutatie

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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
mutation {
  partyCreateWorkflow(
    input: [
      {
        location: {
          administrativeArea: "Utah"
          administrativeAreaCode: "UT"
          countryCode: US
          line1: "123 Test Street"
          locality: "St George"
          postalCode: "84770"
        }
        person: { companyName: "test Corp", phone: "8018565714" }
        type: ORIGIN
      }
      {
        location: {
          administrativeArea: "Quebec"
          administrativeAreaCode: "QC"
          countryCode: CA
          line1: "2147 Pitfield Blvd"
          locality: "Pierrefonds"
          postalCode: "H9H 3C7"
        }
        person: {
          email: "test@gmail.com"
          firstName: "firstName"
          lastName: "lastName"
          phone: "5022303021"
          companyName: "goProTest"
          metadata: { key: "key", value: "value" }
        }
        type: DESTINATION
      }
    ]
  ) {
    type
    id
    organization
  }
  itemCreateWorkflow(
    input: {
      amount: "50"
      currencyCode: USD
      quantity: 1
      sku: "test1"
      description: "shoes"
      hsCode: "670121"
    }
  ) {
    amount
    id
    sku
  }
  cartonsCreateWorkflow(
    input: {
      dimensionalUnit: INCH
      height: "5"
      length: "5"
      weight: "5"
      weightUnit: POUND
      width: "10"
    }
  ) {
    items {
      item {
        amount
        id
        quantity
        sku
      }
    }
    length
    width
    weight
    weightUnit
    height
    id
  }
  shipmentCreateWorkflow(
    input: { orderId: "order_627db90e-d2e2-4499-b388-bfd5d8d33e18" }
  ) {
    id
    status
    shipmentCartons {
      id
      label {
        id
        url
        labelAmounts {
          amount
          amountType
        }
      }
    }
    customsDocuments {
      id
      fileType
      fileUrl
    }
  }
}

Antwoord

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
{
  "data": {
    "shipmentCreateWorkflow": {
      "id": "shipment_cd535d6f-c92a-41a9-ae70-f6e67ed30dc9",
      "status": "CREATED"
    },
    "shipmentCartons": [
      {
        "id": "label_171c7cf5-b005-45cb-bac4-2bfc141dbacb",
        "trackingNumber": "794602938880",
        "status": "CREATED",
        "documentFiling": "ELECTRONIC",
        "labelImage": "{{BASE64_ENCODED_IMAGE}}",
        "labelAmounts": [
          {
            "amount": 137.87,
            "amountType": "QUOTE"
          }
        ],
        "shipmentCarton": "shipment_carton_480d776e-48d8-4699-9b37-bc26c7d0cd1b",
        "statusTransitions": [
          {
            "changedAt": "2024-02-09T18:54:37.158Z",
            "note": "Label created",
            "status": "CREATED"
          }
        ]
      }
    ]
  }
}
3

Annuleer een zending

In het geval dat een klant een zending wil annuleren, kunt u de volgende mutatie gebruiken die alle labels die aan de zending zijn gekoppeld, annuleert.

Verzoek

1
2
3
4
5
6
7
8
9
10
11
12
mutation {
  shipmentStatusUpdate(
    input: {
      shipment: "shipment_f1fe4dbd-e471-49fa-94e7-84e369083223"
      status: VOIDED
      note: "Voiding shipment"
    }
  ) {
    id
    status
  }
}

Was deze pagina nuttig?