Skip to content

Latest commit

 

History

History
45 lines (40 loc) · 8.91 KB

carrieraccountbase.md

File metadata and controls

45 lines (40 loc) · 8.91 KB

CarrierAccountBase

Example Usage

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

let value: CarrierAccountBase = {
  accountId: "****",
  carrier: "usps",
  parameters: {
    accountNumber: "94567e",
    aiaCountryIso2: "US",
    billingAddressCity: "San Francisco",
    billingAddressCountryIso2: "US",
    billingAddressState: "CA",
    billingAddressStreet1: "731 Market St",
    billingAddressStreet2: "STE 200",
    billingAddressZip: "94103",
    collecCountryIso2: "US",
    collecZip: "94103",
    company: "Shippo",
    currencyCode: "USD",
    email: "[email protected]",
    fullName: "Shippo Meister",
    hasInvoice: false,
    invoiceControlid: "1234",
    invoiceDate: "20210529",
    invoiceNumber: "1112234",
    invoiceValue: "11.23",
    phone: "1112223333",
    title: "Manager",
    upsAgreements: false,
  },
};

Fields

Field Type Required Description Example
accountId string ✔️ Unique identifier of the account. Please check the carrier accounts tutorial
page for the account_id per carrier.

To protect account information, this field will be masked in any API response.		 ****
active boolean ➖ Determines whether the account is active. When creating a shipment, if no carrier_accounts are explicitly
passed Shippo will query all carrier accounts that have this field set. By default, this is set to True.
carrier string ✔️ Carrier token, see Carriers

Please check the carrier accounts tutorial page for all supported carriers.		 usps
parameters components.CarrierAccountBaseParameters ➖ N/A