Zonos Collect integrates into your existing landed cost workflow. When you add quoteType: COLLECT to your landedCostCalculateWorkflow mutation, the request functions identically to a standard landed cost calculation; it returns all the same data, but additionally triggers the Collect workflow.
The process is simple: specify quoteType: COLLECT in your request, and the system automatically generates a payment cart, sends the cart link to the destination party's email, and converts the quote to an order once payment is completed.
Use the same GraphQL workflow you're already familiar with, just add one parameter. Adding quoteType: COLLECT to your landedCostCalculateWorkflow input triggers the entire Collect process while maintaining all existing functionality. The links field in the response returns the checkout session URL, which you can store and use for follow-up with the payee as needed.
Quotes and orders: Collect quotes and orders display with "COLLECT" badges in Dashboard. You can filter by the quote type to view and manage collect-specific quotes and monitor payment status.
Email branding: Adjust the email branding for Collect payment carts under Dashboard → Settings → Email Templates
When you create a Collect quote, your customer receives an automated email with a secure payment link. The payment cart displays duties, taxes, and fees with full transparency while keeping your product pricing private.
For complete details on the payment process, supported countries and languages, and customization options, see the Consignee experience guide.
GraphQL API ReferenceTypes, inputs, and operations used in this guide
Get started
Get started with Collect
Collect duties, taxes, and fees from consignees before delivery.
How it works
Zonos Collect integrates into your existing landed cost workflow. When you add
quoteType:COLLECTto yourlandedCostCalculateWorkflowmutation, the request functions identically to a standard landed cost calculation; it returns all the same data, but additionally triggers the Collect workflow.The process is simple: specify
quoteType:COLLECTin your request, and the system automatically generates a payment cart, sends the cart link to the destination party's email, and converts the quote to an order once payment is completed.Create a Collect quote
Use the same GraphQL workflow you're already familiar with, just add one parameter. Adding
quoteType: COLLECTto yourlandedCostCalculateWorkflowinput triggers the entire Collect process while maintaining all existing functionality. Thelinksfield in the response returns the checkout session URL, which you can store and use for follow-up with the payee as needed.mutation CollectQuote($parties: [PartyCreateWorkflowInput!]!$items: [ItemCreateWorkflowInput!]!$shipmentRating: ShipmentRatingCreateWorkflowInput!$landedCost: LandedCostCalculateWorkflowInput!) {partyCreateWorkflow(input: $parties) {typeidorganization}itemCreateWorkflow(input: $items) {idamountquantitydescription}cartonizeWorkflow {id}shipmentRatingCreateWorkflow(input: $shipmentRating) {idamount}landedCostCalculateWorkflow(input: $landedCost) {idlandedCostGuaranteeCodelinks {keyurl}amountSubtotals {dutiesfeestaxeslandedCostTotal}fees {amountcurrencytypeitem {productId}}}}Webhooks
Configure an
ORDER_CREATEDwebhook to get notified as soon as any quote converts to an order:mutation CreateOrderWebhook($input: WebhookCreateInput!) {webhookCreate(input: $input) {idstatusurl}}The payload will include a type field. Check
payload.type === "COLLECT"to handle only Collect orders:javascript
if (payload.type === "COLLECT") { }Dashboard management
Quotes and orders: Collect quotes and orders display with "COLLECT" badges in Dashboard. You can filter by the quote type to view and manage collect-specific quotes and monitor payment status.
Email branding: Adjust the email branding for Collect payment carts under Dashboard → Settings → Email Templates
Consignee experience
When you create a Collect quote, your customer receives an automated email with a secure payment link. The payment cart displays duties, taxes, and fees with full transparency while keeping your product pricing private.
For complete details on the payment process, supported countries and languages, and customization options, see the Consignee experience guide.
ItemCreateWorkflowInput PartyCreateWorkflowInput ShipmentRatingCreateWorkflowInput WebhookCreateInput
cartonizeWorkflow itemCreateWorkflow landedCostCalculateWorkflow partyCreateWorkflow shipmentRatingCreateWorkflow webhookCreate
Was this page helpful?