input CreateShippingPlanInput

Fields

FieldTypeDescription
subtotalString

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

shipping_priceString

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

total_priceString

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

warehouse_idString!

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

warehouse_noteString

Warehouse note for this shipping plan.

vendor_po_numberString

Vendor po number for this shipping plan.

line_items[LineItemInput]!

List of line items associated with this shipping plan.

packages[PackageInput]

List of packages associated with this shipping plan.

palletPalletData

Pallet for this shipping plan.

Referenced By

Example

{
  "subtotal": "19.99",
  "shipping_price": "19.99",
  "total_price": "19.99",
  "warehouse_id": "V2FyZWhvdXNlOjEyMzQ=",
  "warehouse_note": "Customer requested expedited handling.",
  "vendor_po_number": "PO-100045",
  "line_items": [[{sku: "BLUE-TEE-M", quantity: 2}]],
  "packages": [[{id: "UGFja2FnZUlucHV0OjEyMzQ="}]],
  "pallet": {id: "UGFsbGV0RGF0YToxMjM0"}
}