Skip to content

Latest commit

 

History

History
37 lines (32 loc) · 18.9 KB

lineitembase.md

File metadata and controls

37 lines (32 loc) · 18.9 KB

LineItemBase

Example Usage

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

let value: LineItemBase = {
  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",
};

Fields

Field Type Required Description Example
currency string ➖ Currency of the total_price amount. USD
manufactureCountry string ➖ Country the item was manufactured in. In the Shippo dashboard, this value will be used ot pre-fill the customs declaration when creating a label for this order. US
maxDeliveryTime Date ➖ The date and time this item needs to be delivered by, i.e. by when the carrier delivers it to the buyer.
This value is used by some platforms such as eBay to measure a seller's shipping time and performance.
It will be displayed in the Shippo dashboard.		 2016-07-23T00:00:00Z
maxShipTime Date ➖ The date and time this item needs to be fulfilled by, i.e. by when the shipping label needs to be
created and handed over to the carrier. This value is used by some platforms such as eBay to measure
a seller's handling time and performance. It will be displayed in the Shippo dashboard.		 2016-07-23T00:00:00Z
quantity number ➖ The quantity of this item in this order. 20
sku string ➖ The stock keeping unit value of this item. HM-123
title string ➖ Title of the line item. Hippo Magazines
totalPrice string ➖ Total price paid by the buyer for this item (or these items, if quantity > 1). 12.1
variantTitle string ➖ A variant is a specific variation of an item (e.g. size M or color blue).
Variants might be exposed as a separate resource in the future too.
Currently the variant title is a free text field describing the variant.		 June Edition
weight string ➖ Total weight of this/these item(s). Instead of specifying the weight of all items,
you can also set the total_weight value of the order object.		 0.4
weightUnit components.WeightUnitEnum ➖ The unit used for weight. lb