@shippo/shippo-mcp 0.8.39 → 0.8.43

package/src/mcp-server/tools/batchesGet.ts

@@ -14,10 +14,12 @@ export const tool$batchesGet: ToolDefinition<typeof args> = {
   name: "batches-get",
   description: `Retrieve a batch
 
-Returns a batch using an object ID. <br> Batch shipments are displayed 100 at a time.  You can iterate 
-through each \`page\` using the \`?page= query\` parameter.  You can also filter based on batch shipment 
-status, for example, by passing a query param like \`?object_results=creation_failed\`. <br> 
-For more details on filtering results, see our guide on <a href="https://docs.goshippo.com/docs/api_concepts/filtering/" target="blank"> filtering</a>.`,
+Returns a batch using an object ID. Batch shipments are displayed 100 at a time. You can iterate through each \`page\` using the \`?page=\` query parameter. You can also filter based on batch shipment status, for example, by passing a query param like \`?object_results=creation_failed\`.
+
+**IMPORTANT: There is NO batches-list endpoint in the Shippo API.**
+You must know the batch \`object_id\` (returned when you created the batch) to retrieve it.
+Store batch IDs when creating batches if you need to access them later.
+`,
   annotations: {
     "title": "",
     "destructiveHint": false,

package/src/models/order.ts

@@ -4,6 +4,10 @@
 
 import * as z from "zod";
 import { Address, Address$zodSchema } from "./address.js";
+import {
+  AddressValidationResults,
+  AddressValidationResults$zodSchema,
+} from "./addressvalidationresults.js";
 import { LineItem, LineItem$zodSchema } from "./lineitem.js";
 import {
   OrderShopAppEnum,
@@ -15,6 +19,63 @@ import {
 } from "./orderstatusenum.js";
 import { WeightUnitEnum, WeightUnitEnum$zodSchema } from "./weightunitenum.js";
 
+/**
+ * <a href="#tag/Addresses">Address</a> object of the sender / seller. Will be returned expanded by default.
+ */
+export type OrderAddressFrom = {
+  name?: string | undefined;
+  company?: string | undefined;
+  street1?: string | undefined;
+  street2?: string | undefined;
+  street3?: string | undefined;
+  street_no?: string | undefined;
+  city?: string | undefined;
+  state?: string | undefined;
+  zip?: string | undefined;
+  country: string;
+  phone?: string | undefined;
+  email?: string | undefined;
+  is_residential?: boolean | null | undefined;
+  metadata?: string | undefined;
+  is_complete?: boolean | undefined;
+  object_created?: string | undefined;
+  object_id?: string | undefined;
+  object_owner?: string | undefined;
+  object_updated?: string | undefined;
+  validation_results?: AddressValidationResults | undefined;
+  test?: boolean | null | undefined;
+};
+
+export const OrderAddressFrom$zodSchema: z.ZodType<
+  OrderAddressFrom,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  city: z.string().optional(),
+  company: z.string().optional(),
+  country: z.string(),
+  email: z.string().optional(),
+  is_complete: z.boolean().optional(),
+  is_residential: z.boolean().nullable().optional(),
+  metadata: z.string().optional(),
+  name: z.string().optional(),
+  object_created: z.string().datetime({ offset: true }).optional(),
+  object_id: z.string().optional(),
+  object_owner: z.string().optional(),
+  object_updated: z.string().datetime({ offset: true }).optional(),
+  phone: z.string().optional(),
+  state: z.string().optional(),
+  street1: z.string().optional(),
+  street2: z.string().optional(),
+  street3: z.string().optional(),
+  street_no: z.string().optional(),
+  test: z.boolean().nullable().optional(),
+  validation_results: AddressValidationResults$zodSchema.optional(),
+  zip: z.string().optional(),
+}).describe(
+  "<a href=\"#tag/Addresses\">Address</a> object of the sender / seller. Will be returned expanded by default.",
+);
+
 export type OrderTransaction = {};
 
 export const OrderTransaction$zodSchema: z.ZodType<
@@ -24,20 +85,20 @@ export const OrderTransaction$zodSchema: z.ZodType<
 > = z.object({});
 
 export type Order = {
-  currency?: string | undefined;
-  notes?: string | undefined;
-  order_number?: string | undefined;
+  currency?: string | null | undefined;
+  notes?: string | null | undefined;
+  order_number?: string | null | undefined;
   order_status?: OrderStatusEnum | undefined;
   placed_at: string;
-  shipping_cost?: string | undefined;
-  shipping_cost_currency?: string | undefined;
-  shipping_method?: string | undefined;
-  subtotal_price?: string | undefined;
-  total_price?: string | undefined;
-  total_tax?: string | undefined;
-  weight?: string | undefined;
+  shipping_cost?: string | null | undefined;
+  shipping_cost_currency?: string | null | undefined;
+  shipping_method?: string | null | undefined;
+  subtotal_price?: string | null | undefined;
+  total_price?: string | null | undefined;
+  total_tax?: string | null | undefined;
+  weight?: string | null | undefined;
   weight_unit?: WeightUnitEnum | undefined;
-  from_address?: Address | undefined;
+  from_address?: OrderAddressFrom | null | undefined;
   to_address: Address;
   line_items?: Array<LineItem> | undefined;
   object_id?: string | undefined;
@@ -48,24 +109,25 @@ export type Order = {
 
 export const Order$zodSchema: z.ZodType<Order, z.ZodTypeDef, unknown> = z
   .object({
-    currency: z.string().optional(),
-    from_address: Address$zodSchema.optional(),
+    currency: z.string().nullable().optional(),
+    from_address: z.lazy(() => OrderAddressFrom$zodSchema).nullable()
+      .optional(),
     line_items: z.array(LineItem$zodSchema).optional(),
-    notes: z.string().optional(),
+    notes: z.string().nullable().optional(),
     object_id: z.string().optional(),
     object_owner: z.string().optional(),
-    order_number: z.string().optional(),
+    order_number: z.string().nullable().optional(),
     order_status: OrderStatusEnum$zodSchema.optional(),
     placed_at: z.string(),
-    shipping_cost: z.string().optional(),
-    shipping_cost_currency: z.string().optional(),
-    shipping_method: z.string().optional(),
+    shipping_cost: z.string().nullable().optional(),
+    shipping_cost_currency: z.string().nullable().optional(),
+    shipping_method: z.string().nullable().optional(),
     shop_app: OrderShopAppEnum$zodSchema.optional(),
-    subtotal_price: z.string().optional(),
+    subtotal_price: z.string().nullable().optional(),
     to_address: Address$zodSchema,
-    total_price: z.string().optional(),
-    total_tax: z.string().optional(),
+    total_price: z.string().nullable().optional(),
+    total_tax: z.string().nullable().optional(),
     transactions: z.array(z.lazy(() => OrderTransaction$zodSchema)).optional(),
-    weight: z.string().optional(),
+    weight: z.string().nullable().optional(),
     weight_unit: WeightUnitEnum$zodSchema.optional(),
   });

package/src/models/ordercreaterequest.ts

@@ -15,18 +15,18 @@ import {
 import { WeightUnitEnum, WeightUnitEnum$zodSchema } from "./weightunitenum.js";
 
 export type OrderCreateRequest = {
-  currency?: string | undefined;
-  notes?: string | undefined;
-  order_number?: string | undefined;
+  currency?: string | null | undefined;
+  notes?: string | null | undefined;
+  order_number?: string | null | undefined;
   order_status?: OrderStatusEnum | undefined;
   placed_at: string;
-  shipping_cost?: string | undefined;
-  shipping_cost_currency?: string | undefined;
-  shipping_method?: string | undefined;
-  subtotal_price?: string | undefined;
-  total_price?: string | undefined;
-  total_tax?: string | undefined;
-  weight?: string | undefined;
+  shipping_cost?: string | null | undefined;
+  shipping_cost_currency?: string | null | undefined;
+  shipping_method?: string | null | undefined;
+  subtotal_price?: string | null | undefined;
+  total_price?: string | null | undefined;
+  total_tax?: string | null | undefined;
+  weight?: string | null | undefined;
   weight_unit?: WeightUnitEnum | undefined;
   from_address?: AddressCreateRequest | undefined;
   to_address: AddressCreateRequest;
@@ -38,20 +38,20 @@ export const OrderCreateRequest$zodSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  currency: z.string().optional(),
+  currency: z.string().nullable().optional(),
   from_address: AddressCreateRequest$zodSchema.optional(),
   line_items: z.array(LineItemBase$zodSchema).optional(),
-  notes: z.string().optional(),
-  order_number: z.string().optional(),
+  notes: z.string().nullable().optional(),
+  order_number: z.string().nullable().optional(),
   order_status: OrderStatusEnum$zodSchema.optional(),
   placed_at: z.string(),
-  shipping_cost: z.string().optional(),
-  shipping_cost_currency: z.string().optional(),
-  shipping_method: z.string().optional(),
-  subtotal_price: z.string().optional(),
+  shipping_cost: z.string().nullable().optional(),
+  shipping_cost_currency: z.string().nullable().optional(),
+  shipping_method: z.string().nullable().optional(),
+  subtotal_price: z.string().nullable().optional(),
   to_address: AddressCreateRequest$zodSchema,
-  total_price: z.string().optional(),
-  total_tax: z.string().optional(),
-  weight: z.string().optional(),
+  total_price: z.string().nullable().optional(),
+  total_tax: z.string().nullable().optional(),
+  weight: z.string().nullable().optional(),
   weight_unit: WeightUnitEnum$zodSchema.optional(),
 });