Skip to content

Latest commit

 

History

History
50 lines (45 loc) · 18.2 KB

carrieraccount.md

File metadata and controls

50 lines (45 loc) · 18.2 KB

CarrierAccount

Example Usage

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

let value: CarrierAccount = {
  accountId: "****",
  carrier: "usps",
  parameters: {
    firstName: "Rose",
    lastName: "Gulgowski",
    phoneNumber: "(585) 967-5964 x60362",
    fromAddressSt: "<value>",
    fromAddressCity: "<value>",
    fromAddressState: "<value>",
    fromAddressZip: "<value>",
    fromAddressCountryIso2: "<value>",
  },
  carrierName: "USPS",
  isShippoAccount: false,
  objectId: "6aa34d5f6865448fbb1ee93636e98999",
  objectOwner: "[email protected]",
  serviceLevels: [
    {
      name: "Priority Mail Express",
      token: "usps_priority_express",
      supportsReturnLabels: true,
    },
  ],
  test: 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.CarrierAccountParameters ➖ N/A
carrierName any ➖ Carrier name, see Carriers
 USPS
isShippoAccount boolean ➖ N/A false
metadata string ➖ N/A
objectId string ➖ Unique identifier of the carrier account object. 6aa34d5f6865448fbb1ee93636e98999
objectOwner string ➖ Username of the user who created the carrier account object. [email protected]
serviceLevels components.CarrierAccountServiceLevel[] ➖ N/A
test boolean ➖ Indicates whether the object has been created in test mode. false