Skip to content

Latest commit

 

History

History
53 lines (48 loc) · 9 KB

liveratecreaterequest.md

File metadata and controls

53 lines (48 loc) · 9 KB
Raw

LiveRateCreateRequest

Example Usage

import { LiveRateCreateRequest } from "shippo/models/components";

let value: LiveRateCreateRequest = {
  addressFrom: "<value>",
  addressTo: {
    name: "Shwan Ippotle",
    company: "Shippo",
    street1: "215 Clayton St.",
    street3: "",
    streetNo: "",
    city: "San Francisco",
    state: "CA",
    zip: "94117",
    country: "US",
    phone: "+1 555 341 9393",
    email: "[email protected]",
    isResidential: true,
    metadata: "Customer ID 123456",
    validate: true,
  },
  lineItems: [
    {
      currency: "USD",
      manufactureCountry: "US",
      maxDeliveryTime: new Date("2016-07-23T00:00:00Z"),
      maxShipTime: new Date("2016-07-23T00:00:00Z"),
      quantity: 20,
      sku: "HM-123",
      title: "Hippo Magazines",
      totalPrice: "12.1",
      variantTitle: "June Edition",
      weight: "0.4",
      weightUnit: "lb",
      objectId: "abf7d5675d744b6ea9fdb6f796b28f28",
    },
  ],
  parcel: "5df144dca289442cv7a06",
};

Fields

Field Type Required Description Example
addressFrom components.LiveRateCreateRequestAddressFrom ➖ The sender address, which includes your name, company name, street address, city, state, zip code,
country, phone number, and email address (strings). Special characters should not be included in
any address element, especially name, company, and email.
addressTo components.LiveRateCreateRequestAddressTo ✔️ The recipient address, which includes the recipient's name, company name, street address, city, state, zip code,
country, phone number, and email address (strings). Special characters should not be included in
any address element, especially name, company, and email.
lineItems components.LineItem[] ✔️ Array of Line Item objects
parcel components.LiveRateCreateRequestParcel ➖ Object ID for an existing User Parcel Template OR a fully formed Parcel object. 5df144dca289442cv7a06