Docs | EntryGo

Use EntryGo when your application needs to:

sync products
sync orders
plan exports
execute exports
submit shipments to brokers or partners

#Install

bash

pnpm add @entrygo/sdk

#Environment

bash

export ENTRYGO_API_KEY="shpbndl_live_..."

#Client initialization

import { EntryGo } from "@entrygo/sdk";

const entrygo = new EntryGo({
  apiKey: process.env.ENTRYGO_API_KEY
});

#Verify the integration

const verification = await entrygo.setup.verify();

The verification result reports install readiness and the next required step without opening the dashboard.

#Canonical first export loop

const product = await entrygo.products.upsert({
  externalId: "prod-ext-1",
  sku: "JKT-001",
  name: "Wool jacket",
  originCountry: "CA",
  declaredValueUsd: 110,
  materials: ["wool"]
});

const order = await entrygo.orders.create({
  externalId: "ord-ext-1",
  destinationCountry: "US",
  destinationRegion: "CA",
  destinationPostalCode: "94105",
  items: [
    {
      productId: product.id,
      quantity: 1,
      unitValueUsd: 110
    }
  ]
});

const plan = await entrygo.exports.plan(order.id);
const result = await entrygo.exports.execute(plan.batch_id);
const inspection = await entrygo.exports.inspect(plan.exportId);

#Primitive naming

entrygo.products.upsert(...)
entrygo.orders.create(...)
entrygo.exports.plan(...)
entrygo.exports.execute(...)
entrygo.exports.inspect(...)

#Setup status

const status = await entrygo.setup.status();

const verification = await entrygo.setup.verify();

This returns machine-detectable setup progress, including:

configured
missing
next_step

#Notes

entrygo.exports.plan(orderId) uses the demo planning flow when you pass a simple order ID.
entrygo.exports.execute(batchId) accepts a batch ID directly for the first successful export loop.
Raw protocol payloads remain available through products.sync, orders.sync, and exports.plan({...}).