shipmentextra.md

ShipmentExtra

An object holding optional extra services to be requested.

Example Usage

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

let value: ShipmentExtra = {
  accountsReceivableCustomerAccount: {
    prefix: "ABC",
    value: "value",
    refSort: 1,
  },
  appropriationNumber: {
    prefix: "ABC",
    value: "value",
    refSort: 1,
  },
  billOfLadingNumber: {
    prefix: "ABC",
    value: "value",
    refSort: 1,
  },
  cod: {
    amount: "5.5",
    currency: "USD",
    paymentMethod: "CASH",
  },
  codNumber: {
    prefix: "ABC",
    value: "value",
    refSort: 1,
  },
  customerReference: {
    refSort: 1,
  },
  dealerOrderNumber: {
    prefix: "ABC",
    value: "value",
    refSort: 1,
  },
  deptNumber: {
    refSort: 3,
  },
  fdaProductCode: {
    prefix: "ABC",
    value: "value",
    refSort: 1,
  },
  insurance: {
    amount: "5.5",
    currency: "USD",
  },
  invoiceNumber: {
    refSort: 2,
  },
  manifestNumber: {
    prefix: "ABC",
    value: "value",
    refSort: 1,
  },
  modelNumber: {
    prefix: "ABC",
    value: "value",
    refSort: 1,
  },
  partNumber: {
    prefix: "ABC",
    value: "value",
    refSort: 1,
  },
  poNumber: {
    refSort: 2,
  },
  productionCode: {
    prefix: "ABC",
    value: "value",
    refSort: 1,
  },
  purchaseRequestNumber: {
    prefix: "ABC",
    value: "value",
    refSort: 1,
  },
  rmaNumber: {
    refSort: 1,
  },
  salespersonNumber: {
    prefix: "ABC",
    value: "value",
    refSort: 1,
  },
  serialNumber: {
    prefix: "ABC",
    value: "value",
    refSort: 1,
  },
  storeNumber: {
    prefix: "ABC",
    value: "value",
    refSort: 1,
  },
  transactionReferenceNumber: {
    prefix: "ABC",
    value: "value",
    refSort: 1,
  },
};

Fields

Field	Type	Required	Description
accountsReceivableCustomerAccount	components.UPSReferenceFields	➖	N/A
alcohol	components.Alcohol	➖	Indicates that a shipment contains Alcohol (Fedex and UPS only).
ancillaryEndorsement	components.AncillaryEndorsement	➖	Specify an ancillary service endorsement to provide the USPS with instructions on how to handle undeliverable-as-addressed pieces (DHL eCommerce only).
appropriationNumber	components.UPSReferenceFields	➖	N/A
authorityToLeave	boolean	➖	Request true to give carrier permission to leave the parcel in a safe place if no one answers the door (where supported). When set to false, if no one is available to receive the item, the parcel will not be left (*surcharges may be applicable).
billOfLadingNumber	components.UPSReferenceFields	➖	N/A
billing	components.Billing	➖	Specify billing details (UPS, FedEx, and DHL Germany only).
bypassAddressValidation	boolean	➖	Bypasses address validation (USPS, UPS, & LaserShip only).
carbonNeutral	boolean	➖	Request carbon offsets by passing true (UPS only).
carrierHubId	string	➖	Identifies the carrier injection site.
carrierHubTravelTime	number	➖	Travel time in hours from fulfillment center to carrier injection site.
cod	components.Cod	➖	Specify collection on delivery details (UPS only).
codNumber	components.UPSReferenceFields	➖	N/A
containerType	string	➖	Specify container type.
criticalPullTime	string	➖	Carrier arrival time to pickup packages from the fulfillment center. UTC format: %Y-%m-%dT%H:%M:%SZ
customerBranch	string	➖	Specify customer branch (Lasership only).
customerReference	components.CustomerReference	➖	Specify the reference field on the label (FedEx and UPS only).
dangerousGoods	components.DangerousGoodsObject	➖	Container for specifying the presence of dangerous materials. This is specific to USPS, and if any contents are provided, only certain USPS service levels will be eligible. For more information, see our guide on hazardous or dangerous materials shipping.
dangerousGoodsCode	components.DangerousGoodsCode	➖	Dangerous Goods Code (DHL eCommerce only). See Category Codes
dealerOrderNumber	components.UPSReferenceFields	➖	N/A
deliveryInstructions	string	➖	Specify delivery instructions. Up to 500 characters. (FedEx and OnTrac only).
deptNumber	components.DepartmentNumber	➖	Specify the department number field on the label (FedEx and UPS only).
dryIce	components.DryIce	➖	Specify that the package contains Dry Ice (FedEx, Veho, and UPS only).
fdaProductCode	components.UPSReferenceFields	➖	N/A
fulfillmentCenter	string	➖	The fulfilment center where the package originates from.
insurance	components.Insurance	➖	To add 3rd party insurance powered by XCover, specify amount, content, and currency. Alternatively, you can choose carrier provided insurance by additionally specifying provider (UPS, FedEx and OnTrac only). If you do not want to add insurance to your shipment, do not set these parameters.
invoiceNumber	components.InvoiceNumber	➖	Specify the invoice number field on the label (FedEx and UPS only).
isReturn	boolean	➖	This field specifies if it is a scan-based return shipment. See the Create a return shipment section for more details.
lasershipAttrs	components.ShipmentExtraLasershipAttributesEnum[]	➖	Specify Lasership Attributes (Lasership only). Multiple options accepted.
lasershipDeclaredValue	string	➖	Declared value (Lasership only). Defaults to 50.00.
manifestNumber	components.UPSReferenceFields	➖	N/A
modelNumber	components.UPSReferenceFields	➖	N/A
partNumber	components.UPSReferenceFields	➖	N/A
poNumber	components.PoNumber	➖	Specify the PO number field on the label (FedEx and UPS only).
preferredDeliveryTimeframe	components.PreferredDeliveryTimeframe	➖	Required for DHL Germany Paket Sameday. Designates a desired timeframe for delivery. Format is HHMMHHMM
premium	boolean	➖	Add premium service to a shipment (DHL Germany international shipments only).
productionCode	components.UPSReferenceFields	➖	N/A
purchaseRequestNumber	components.UPSReferenceFields	➖	N/A
qrCodeRequested	boolean	➖	Request a QR code for a given transaction when creating a shipping label (USPS domestic and Evri UK only).
reference1	string	➖	Optional text to be printed on the shipping label if supported by carrier. Up to 50 characters.
reference2	string	➖	Optional text to be printed on the shipping label if supported by carrier. Up to 50 characters. For DHL eCommerce, this field can be used for billing reference.
requestRetailRates	boolean	➖	Returns retail rates instead of account-based rates (UPS and FedEx only).
returnServiceType	components.ReturnServiceType	➖	Request additional return option for return shipments (UPS and Lasership only).
rmaNumber	components.RmaNumber	➖	Specify the RMA number field on the label (FedEx and UPS only).
saturdayDelivery	boolean	➖	Marks shipment as to be delivered on a Saturday.
salespersonNumber	components.UPSReferenceFields	➖	N/A
serialNumber	components.UPSReferenceFields	➖	N/A
signatureConfirmation	components.SignatureConfirmation	➖	Request standard or adult signature confirmation. You can alternatively request Certified Mail (USPS only) or Indirect signature (FedEx only) or Carrier Confirmation (Deutsche Post only).
storeNumber	components.UPSReferenceFields	➖	N/A
transactionReferenceNumber	components.UPSReferenceFields	➖	N/A