UNPKG

@shipengine/connect-order-source-api

Version:

This is the typescript/javascript definitions for the order source api

138 lines (137 loc) 7.22 kB
/** @description These replacement fields can be used in any packing slip template field */ export declare enum PackingSlipOrderPlaceholder { /** @description Replaced with the order id */ OrderId = "[Order ID]", /** @description Replaced with the order number */ OrderNumber = "[Order #]", /** @description Replaced with the import key */ ImportKey = "[Import Key]", /** @description Replaced with the scan order number */ ScanOrderNumber = "[Scan Order #]", /** @description Replaced with the barcode */ Barcode = "[Barcode]", /** @description Replaced with the carrier fee */ CarrierFee = "[Carrier Fee]", /** @description Replaced with the USPS Zone */ USPSZone = "[USPS Zone]", /** @description Replaced with the buyers name */ BuyerName = "[Buyer Name]", /** @description Replaced with the username of the buyer */ Username = "[Username]", /** @description Replaced with the stores company name */ StoreCompanyName = "[Store Company Name]", /** @description Replaced with the stores phone */ StorePhone = "[Store Phone]", /** @description Replaced with the store name */ StoreName = "[Store Name]", /** @description Replaced with the stores logo */ StoreLogo = "[Store Logo]", /** @description Replaced with the stores website */ StoreWebsite = "[Store Website]", /** @description Replaced with the stores email */ StoreEmail = "[Store Email]", /** @description Replaced with the amount of shipping paid */ ShippingPaid = "[Shipping Paid]", /** @description Replaced with the amount of tax paid */ TaxPaid = "[Tax Paid]", /** @description Replaced with the total dimensions of the shipment "L x W x H (Unit)" @example "10 x 12 x 14 (in)" */ Dimensions = "[Dimensions]", /** @description Replaced with the total weight of the shipment @example "1 lbs. 2 oz." */ Weight = "[Weight]", /** @description Replaced with the shipping service name @example "UPS Next Day" */ ShippingService = "[Shipping Service]", /** @description Replaced with the carrier the order is being shipped with @example "USPS" */ CarrierName = "[Carrier Name]", /** @description Replaced with the requested shipping service */ RequestedShippingService = "[Requested Shipping Service]", /** @description Replaced with the package type */ PackageType = "[Package Type]", /** @description Replaced with the items total printed value */ ItemsTotal = "[Items Total]", /** @description Replaced with the order total value */ OrderTotal = "[Order Total]", /** @description Replaced with the amount paid */ AmountPaid = "[Amount Paid]", /** @description Replaced with the packign slip message */ PackingSlipMessage = "[Packing Slip Message]", /** @description Replaced with the internal notes */ InternalNotes = "[Internal Notes]", /** @description Replaced with the notes to the buyer */ NotesToBuyer = "[Notes to Buyer]", /** @description Replaced with the notes from the buyer */ NotesFromBuyer = "[Notes from Buyer]", /** @description Replaced with the custom field 1 */ CustomField1 = "[Custom Field #1]", /** @description Replaced with the custom field 2 */ CustomField2 = "[Custom Field #2]", /** @description Replaced with the custom field 3 */ CustomField3 = "[Custom Field #3]", /** @description Replaced with the warehouse name */ WarehouseName = "[Warehouse Name]", /** @description Replaced with the ship from name */ ShipFromName = "[Ship From Name]", /** @description Replaced with the warehouse address */ WarehouseAddress = "[Warehouse Address]", /** @description Replaced with the ship from address */ ShipFromAddress = "[Ship From Address]", /** @description Replaced with recipient street 1 */ RecipientStreet1 = "[Recipient Street 1]", /** @description Replaced with recipient street 2 */ RecipientStreet2 = "[Recipient Street 2]", /** @description Replaced with recipient street 3 */ RecipientStreet3 = "[Recipient Street 3]", /** @description Replaced with the full country name of the recipient */ RecipientAddressFullCountry = "[Recipient Address Full Country]", /** @description Replaced with the recipients name and company */ RecipientNameAndCompany = "[Recipient Name And Company]", /** @description Replaced with the recipients address */ RecipientAddress = "[Recipient Address]", /** @description Replaced with the recipients company */ RecipientCompany = "[Recipient Company]", /** @description Replaced with recipients name */ RecipientName = "[Recipient Name]", /** @description Replaced with recipients email */ RecipientEmail = "[Recipient Email]", /** @description Replaced with the recipients phone */ RecipientPhone = "[Recipient Phone]", /** @description Replaced with the gift message */ GiftMessage = "[Gift Message]", /** @description Replaced with the recipients city */ RecipientCity = "[Recipient City]", /** @description Replaced with the recipients state */ RecipientState = "[Recipient State]", /** @description Replaced with the recipients postal code */ RecipientPostalCode = "[Recipient Postal Code]", /** @description Replaced with the recipients country @example "US", "CA" */ RecipientCountry = "[Recipient Country]", /** @description Replaced with the billing street 1 */ BillingStreet1 = "[Billing Street 1]", /** @description Replaced with the billing street 2 */ BillingStreet2 = "[Billing Street 2]", /** @description Replaced with the billing street 3 */ BillingStreet3 = "[Billing Street 3]", /** @description Replaced with the full billing address */ BillingAddress = "[Billing Address]", /** @description Replaced with the billing company */ BillingCompany = "[Billing Company]", /** @description Replaced with the billing name */ BillingName = "[Billing Name]", /** @description Replaced with the billing phone */ BillingPhone = "[Billing Phone]", /** @description Replaced with the billing city */ BillingCity = "[Billing City]", /** @description Replaced with billing state */ BillingState = "[Billing State]", /** @description Replaced with the billing postal code */ BillingPostalCode = "[Billing Postal Code]", /** @description Replaced with the billing country */ BillingCountry = "[Billing Country]", /** @description Replaced with the total quantity of items */ TotalQuantity = "[Total Quantity]", /** @description Replaced with the total quantity of items without zero dollar items */ TotalQuantityWithoutZeroDollarItem = "[Total Quantity Without ZeroDollarItem]", /** @description Replaced with the total quantity of items without adjustments */ TotalQuantityWithoutAdjustments = "[Total Quantity Without Adjustments]", /** @description Replaced with the total quantity of items without adjustments and zero dollar items */ TotalQuantityWithoutAdjustmentsAndZeroDollarItems = "[Total Quantity Without Adjustments and ZeroDollarItems]" }