object ShippingPlan

Fields

Field Type Description

id

String

Public API ID for this identifiable.

legacy_id

BigInt

Numeric legacy ID for this identifiable; use only where legacy IDs are required.

account_id

String

Public API account ID that identifies the related record.

warehouse_id

String

Public API warehouse ID. Use this when passing or filtering by a warehouse; warehouse fields are display values or nested objects.

created_at

ISODateTime

Created at as an ISO-8601 datetime, returned in UTC unless otherwise noted.

fulfillment_status

String

Current fulfillment status; use the API status values returned by this field when filtering or updating.

warehouse_note

String

Warehouse note for this shipping plan.

vendor_po_number

String

Vendor po number for this shipping plan.

subtotal

String

Customer-facing charge amount as a decimal monetary value in the order currency; distinct from value/customs_value used for declared value.

shipping_price

String

Customer-facing charge amount as a decimal monetary value in the order currency; distinct from value/customs_value used for declared value.

total_price

String

Customer-facing charge amount as a decimal monetary value in the order currency; distinct from value/customs_value used for declared value.

shipping_method

String

Carrier service or shipping method code.

shipping_carrier

String

Carrier name or carrier code used for shipping.

shipping_name

String

Shipping name for this shipping plan.

tracking_number

String

Carrier tracking number for the shipment or label.

warehouse

Warehouse

Warehouse display value or nested warehouse object for this record. Use warehouse_id when passing a warehouse reference.

pdf_location

String

URL for the PDF location resource.

line_items

ShippingPlanLineItemConnection

List of line items associated with this shipping plan.

Argument	Type	Required
`sort`	`String`	No
`before`	`String`	No
`after`	`String`	No
`first`	`Int`	No
`last`	`Int`	No

packages

ShippingPlanPackageConnection

List of packages associated with this shipping plan.

Argument	Type	Required
`sort`	`String`	No
`before`	`String`	No
`after`	`String`	No
`first`	`Int`	No
`last`	`Int`	No

pallets

ShippingPlanPalletConnection

Pallets for this shipping plan.

Argument	Type	Required
`sort`	`String`	No
`before`	`String`	No
`after`	`String`	No
`first`	`Int`	No
`last`	`Int`	No

origin_of_shipment

String

ISO country code for origin of shipment.

tracking_numbers

ShippingPlanTrackingNumberConnection

Tracking numbers for this shipping plan.

Argument	Type	Required
`sort`	`String`	No
`before`	`String`	No
`after`	`String`	No
`first`	`Int`	No
`last`	`Int`	No

Referenced By

CreateShippingPlanOutput Type
ShippingPlanQueryResult Type

Example

{
  "id": "UmVjb3JkOjEyMzQ=",
  "legacy_id": 1234,
  "account_id": "QWNjb3VudDoxMjM0",
  "warehouse_id": "V2FyZWhvdXNlOjEyMzQ=",
  "created_at": "2026-07-09T15:30:00Z",
  "fulfillment_status": "pending",
  "warehouse_note": "Customer requested expedited handling.",
  "vendor_po_number": "PO-100045",
  "subtotal": "19.99",
  "shipping_price": "19.99",
  "total_price": "19.99",
  "shipping_method": "ups_ground",
  "shipping_carrier": "ups",
  "shipping_name": "July FBA Shipment",
  "tracking_number": "1Z999AA10123456784",
  "warehouse": {id: "V2FyZWhvdXNlOjEyMzQ=", identifier: "Primary Warehouse"},
  "pdf_location": "https://example.com/labels/SHIP-1001.pdf",
  "line_items": [{sku: "BLUE-TEE-M", quantity: 2}],
  "packages": [{id: "U2hpcHBpbmdQbGFuUGFja2FnZToxMjM0"}],
  "pallets": [{id: "U2hpcHBpbmdQbGFuUGFsbGV0OjEyMzQ="}],
  "origin_of_shipment": "US",
  "tracking_numbers": [{id: "U2hpcHBpbmdQbGFuVHJhY2tpbmdOdW1iZXI6MTIzNA=="}]
}