DOCS

Integrate label api

/

귀하의 플랫폼에서 Zonos 배송 생성

고객이 귀하의 플랫폼에서 Zonos 배송 및 라벨을 생성할 수 있도록 합니다.

귀하가 Zonos 고객이 국제적으로 배송할 수 있도록 지원하는 배송 플랫폼이라면, 배송 생성을 위해 Zonos와 연결하는 것이 최우선 고려 사항이 되어야 합니다. 이를 통해 귀하의 플랫폼의 기존 기능을 활용하면서 Zonos가 배송, 라벨 및 지원 세관 문서 생성을 관리하도록 하여 상인과 고객에게 가장 원활한 경험을 제공할 수 있습니다.

Zonos를 사용하여 배송을 생성하는 장점은 다음과 같습니다:

  • 세금 및 관세의 제3자 청구 - 배송 요금에 대해 귀하 또는 귀하의 상인의 운송업체 계좌 번호가 사용되도록 보장하며, 세금 및 관세 청구서는 Zonos로 전송됩니다.
  • 유연성 - 귀하의 플랫폼에서 준수하는 라벨을 생성할 수 있도록 개발 작업을 수행하는 대신, 저희 API와 통합하여 끊임없이 변화하는 국경 간 준수를 저희에게 맡기십시오.
  • 정확한 세관 문서 - Zonos를 사용하여 라벨을 생성할 때, 패키지가 신속하게 세관을 통과할 수 있도록 운송업체에 올바른 세부정보가 전달되도록 보장합니다.

이 가이드는 귀하의 플랫폼에서 배송을 위해 Zonos를 호출할 수 있도록 완전한 엔드 투 엔드 통합을 구현하는 단계를 안내합니다.

고객이 귀하의 플랫폼에서 Zonos 라벨을 인쇄할 수 있도록 허용 

고객이 귀하의 플랫폼에서 Zonos 라벨을 검색할 수 있도록 하려면 아래 단계를 따르십시오.

1

고객이 자신의 Zonos API 자격 증명을 입력할 수 있도록 허용

Zonos APIcredentialToken으로 접근할 수 있습니다. 귀하의 플랫폼은 고객이 Zonos 대시보드에서 credentialToken을 입력할 수 있는 기능을 제공해야 합니다. 여기에서 귀하는 고객을 대신하여 Zonos에 요청을 할 수 있습니다.

2

배송 생성

label을 검색하려면 label과 연결된 shipment을 생성해야 합니다. Zonos는 동일한 요청에서 shipmentslabels를 생성하는 워크플로우로 이 프로세스를 관리합니다. 이 변형을 수행할 때 order에 연결된 landedCost에서 사용된 serviceLevel을 사용할 것이므로 serviceLevel을 전달할 필요가 없습니다. orderId에는 Zonos 주문 ID 또는 귀하의 시스템에 이미 있을 가능성이 있는 accountOrderNumber를 사용할 수 있습니다. 배송 및 라벨이 성공적으로 생성되면, 저희는 BASE64_ENCODED_IMAGElabelImage로 라벨을 반환하거나 라벨을 가져올 수 있는 url로 반환합니다.

변형

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
    }
  }
}

응답

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

배송 취소

고객이 배송을 취소하고자 하는 경우, 다음의 변형을 사용하여 배송에 연결된 모든 라벨을 취소할 수 있습니다.

요청

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
  }
}

이 페이지가 도움이 되었습니까?


질문 있으세요?

문의하세요.

Zonos을 보세요

정책 및 계약