This document provides a breakdown of Rate and Ship Internal API Fields in ShipWise.
Base JSON
Description
dateAdvancedDays: How many total days from today should the label be printed for. This will only change the date not the time.
testMode: Option to print live postage or test postage labels.
preferredLabelFormat: What type of label should be processed. Options are: png or zpl. ZPL requires zplPrintOptions object.
zplPrintOptions: Holds arguments for ZPL printing.
zplPrintOptions.printingHorizontalOffset: How much off the side of the label space should the ZPL label print.
zplPrintOptions.printingVerticalOffset: How much off the top of the label space should the ZPL label print.
zplPrintOptions.printZebraReverse: Option to print the ZPL label flipped 180 degrees with the bottom at the end of the print process.
zplPrintOptions.printingDarkness: How dark should the label text and barcodes be.
zplPrintOptions.printShipToPhone: Option to print the Ship To Phone number on the ZPL label.
zplPrintOptions.printSpeed: How fast should the label print.
zplPrintOptions.printOrderIdBarcode: Option to print Order Id field barcode on the label.
plPrintOptions.dhlIntlPkgidPrefix: What Package Id Prefix should be added to DHL International ZPL labels.
zplPrintOptions.upsmiUseServiceCodeCostCenter: Option to print Code Cost Center on the ZPL label for UPS MI.
valueAddedTaxInformation: Holds arguments for VAT/IOSS taxes.
vatNumber: Unique Government or Broker supplied value corresponding to tax account in destination country.
taxType: 0 = VAT, 1 = IOSS.
issuerCountry: Country that issued the vatNumber value.
packageOverrideInfo: Holds arguments for overriding information about an order.
packageOverrideInfo
Description
customs: Holds arguments for each individual parcel's customs. This object is required for shipping international packages.
customs.contentsDescription: What broad category of items are in the parcel.
customs.originCountry: 2-digit ISO code for the origin country of the item.
customs.signer: Customs form signer at shipping warehouse, often shipping manager or owner.
customs.customsTag: What type of mail is being shipped, accepted values are: "Merchandise", "Donation", "Sample", "Dangerous Goods", "Return Goods", "Documents", "Gift", "Other".
customs.customsTagOtherDesc: If customsTag = "Other" then fill out what type of customs this is.
customs.items: Holds arguments for item custom information, is required for international shipments.
customs.items.itemMarketProductKey: Used as a unique value for the product's database.
customs.items.sku: Used as a unique value for the item's database and throughout the shipping process. Depending on the carrier is passed to the carrier.
customs.items.productSku: Used as a replacement for a blank SKU only during shipping.
customs.items.description: Explains what the specific item is.
customs.items.qty: How many of this sku/item is included in the corresponding parcel.
customs.items.value: Retail cost for a single qty of the item, very important for tax purposes.
customs.items.weight: Weight for a single qty of the item.
customs.items.countryOfMfg: Where was the product produced.
customs.items.stateOrProvOfMfg: US Customs harmonized code.
customs.items.harmCode: Internal ShipWise field populated by customs information from UPS carrier account settings.
customs.items.additionalCustomsItemFields: Populated during the shipping process, used for fields: Export Information, EEI License Code, License Line Value, ECCN Number.
customs.items.additionalCustomsItemFields.value: Tax Id for countries that requires importers/recievers tax identification number (similar to SSN).
customs.consigneeTaxId: How much the customer has already paid in taxes during check out. Used for EPG/RRD & exports from the VSB.
customs.customerPaidTaxes: How much the customer has already paid in duties during check out. Used for EPG/RRD & exports from the VSB.
customs.customerPaidDuties: How much the customer has already paid in duties during check out. Used for EPG/RRD & exports from the VSB.
customs.taxType: What type of tax Id is provided. Accepted values: NationalIdNumber = 1, MilitaryIdNumber = 2, PassportNumber = 3, Other = 4.
customs.taxTypeOptions: Allows multiple tax Id types to be passed.
customs.taxTypeOptions.key: Key has limited accepted values, those values are: NationalIdNumber = 1, MilitaryIdNumber = 2, PassportNumber = 3, Other = 4.
customs.taxTypeOptions.value: Value is what the customer provided for the package.
weightUnit: ShipWise internal field will be populated with value LB.
totalWeight: Weight of the entire parcel including packaging.
serviceFlags: Flags that allow packages to ship out via limited carrier services, accepted values = BPM = Bound Printed Matter, MM = Media Mail, MP = Marketing Parcel.
packaging: Holds arguments for parcel packaging.
packaging.id: ShipWise generated static value, unique for each ShipWise account, for custom packaging.
packaging.boxID: Customer generated static unique value for custom packaging
packaging.clientID: ShipWise account ID.
packaging.description: Brief description describing custom box.
packaging.length: Length of custom box.
packaging.width: Width of custom box.
packaging.height: Height of custom box.
packaging.cost: Value of custom box, only for record keeping purposes. Doesn't get added to package values or passed to carriers.
packaging.barcode: Box SKU barcode, common to be utilized for scanning in packaging during picking.
packaging.dryIceWeightWhenRequired: Value to be added to shipment weight when dry ice is added.
packaging.mailPieceValue: Value used by ShipWise internal system for various carrier fields.
packaging.carrier: For reporting/export purposes.
packaging.isSystemBox: True/False object for indicating if packaging is ShipWise pre-built carrier packaging or if its customer generated.
packaging.pitneyBowesMailPieceValue: Similar to mailPieceValue, but specific to Pitney Bowes. Type of packaging examples: FLAT, PKG, LETTER, etc.
freightClass: For reporting/export purposes.
packageId: Account unique value for each package that allows for quick searching and identifying different packages in ShipWise VSB.
shipMethod: Dynamic value used for mapping order to carrier service/group of services.
items: Holds arguments for what items and quantity to ship.
items.id: Internal ShipWise id for each unique item tied to an order. Can be pulled by querying order information.
quantityToShip: How many of this sku/item is included in the corresponding parcel.
