ShipCompliant data fields

For every shipment you process through ShipCompliant, Manager sends accounting details on the inventory and the transaction in the form of an XML data stream. You can view the contents of these exchanges by logging in to your account on the ShipCompliant web site. Because ShipCompliant often uses different names for the individual data fields, youʼll need to know how these labels correspond to the field names youʼll see on the screen in Manager.

Merchant record—ShipCompliant Product Key In the table below, the Condition column refers to the logical condition that determines which of two alternative Manager data field values is used. For example, for the Inventory field ProductKey, if ShipCompliant Product Key (in the Merchant record) is set to 'Id,' Manager reports the Inventory itemʼs record Id number; if it is set to 'Label,' Manager returns the value of Label.

Strings in quotes are the literal data that Manager sends in the event that it has no exact equivalent to the requested ShipCompliant field. For example, for VolumeUnit, Manager always sends the string “Liter.”

Inventory data

Data fields are found in the Inventory record.

ShipCompliant code:Manager data field:Example:Condition:
BrandKeyBrand KeyScrewtop Wines
DescriptionNameChardonnay, 2016
PercentAlcoholVolume of Alcohol14.5
ProductKeyId/
Label
IN0000429/
Chardonnay, 2016
set by ShipCompliant Product Key in Merchant record
ProductTypeTaxable[checked/not checked]
UnitPriceRetail Unit Price$20.00
VarietalVarietalChardonnay
VintageVintage2012
VolumeAmountLiters0.750
VolumeUnit"Liter"Liter


Transaction data

Unless otherwise noted, data fields are found in the Transaction record.

ShipCompliant code:Manager data field:Example:Condition:
Bill to : CityBilling City/
Shipping City
San Ramon
Bill to : DateOfBirthBirth9/1/1983
Bill to : EmailEmail Address (Customer)user6935@bigisp.com
Bill to : FaxFax (Customer)9259789399
Bill to : FirstNameFirst Name (Customer)Steve
Bill to : LastNameLast Name (Customer)Allers
Bill to : PhoneMain Phone (Customer)925-555-1555
Bill to : Statebilling State/
shipping State
WYshipping State if billing State is empty
Bill to : Street1billing Address/
shipping Address 1
33 Back Streetshipping Address 1 if billing Address is empty
Bill to : Zip1, Zip2billing ZIP/
shipping ZIP
94553shipping ZIP if billing ZIP is empty
BrandBrandKey (Inventory)Screwtop Wines
CarrierServiceShipViaFedEx
CustomerKeyId (Customer)CS0000420
FulfillmentHouseFulfillment House (Merchant)elitewineshipping.com
FulfillmentType"Club"
IsInsured"0"
LicenseRelationship"Default"
OrderType"Club"
PurchaseDateDate Created/
Transaction Date
6/1/2018per setting of Checked for Compliance: 'ShipComp Check'/'ShipComp Commit'
SalesOrderKeyIdTA0039265
SalesTaxCollectedSales Tax$7.31
ShipDateShip Date/
Date Created
9/4/2018per setting of Checked for Compliance: 'ShipComp Check'/'ShipComp Commit'
ShipmentKeyIdTA0039265
ShipmentStatus"InProcess"/
"PaymentAccepted"
per setting of Checked for Compliance: 'ShipComp Check'/'ShipComp Commit'
ShippingS & H$25.00
ShippingService*Shipvia : ShiptypeFedEx : GroundIf Residential Address is checked, add ": Home"
ShipTo : CityShipping CityPleasanton
ShipTo : DateOfBirthBirth5/20/1977
ShipTo : FaxFax (Customer)9259789399
ShipTo : FirstNameFirstHenry
ShipTo : LastNameLastTippler
ShipTo : PhonePhone3105559876
ShipTo : EmailEmailBibulous_Fred@gmail.com
ShipTo : StateStateOH
ShipTo : CompanyCompanyDrinkers Unlimited
ShipTo : Street1Address 123 Vine Street
ShipTo : Street2Address 2Suite 420
ShipTo : Zip1, Zip2ZIP94551
SpecialInstructionsNotesPOS customer


Transaction items

Unless noted, data fields are found in the Transaction Item record.

ShipCompliant code:Manager data field:Example:Condition:
ProductKeyInventory Id/
Inventory Label
IN0000429/
Chardonnay, 2016
set by ShipCompliant Product Key in Merchant record
ProductQuantityItems in Package2
ProductUnitPriceInventory Item Unit Price$36.00
TrackingNumberTracking Code790671421860

*Carrier Service codes

ShipCompliant refers to shipping carriers using a number of three-character codes: for example, “UP2” designates “UPS : Second-day.” The correspondences between these and the strings used in Manager are maintained in the Translation list, in records of Type 'ShipCompliant' and Subtype 'Carrier Service.'


Related topic:

Using ShipCompliant