Are you uncertain about the field name required for your Shipping Rules XML? If you have access to the Production environment in Ship On-premises and can locate the field you wish to target, please place your cursor within that field and press CTRL+SHIFT+ALT+F on your keyboard. A pop-up will then appear on the screen displaying the name of the field.
In the example below, we're checking out the field name for the ReceiverRef field, and you can see that the name needed for Shipping Rules XML is fld_RefRecRef.
Below is a list of some of the most common reference field names. Please refer to the names listed in the fld_Name column. The Display Label represents what is typically seen in the Production interface; however, some field names may differ depending on the carrier. The Kind ID and Enum Name are provided as references for API users.
Shipment reference fields
| fld_ Name | Display label in GUI | KindID | Enum Name |
|---|---|---|---|
| fld_CODReference | Reference (COD) | 2 | eSrkCodReference |
| fld_RefOrderNumber | Ordernumber | 4 | eSrkJobNumber |
| fld_RefProject | Project | 5 | eSrkProjectName |
| fld_ReceiverCustNoSender | Receivers Customer No at Sender | 6 | eSrkReceiverAccountAtSender |
| fld_RefRecRef | ReceiverRef | 7 | eSrkReceiverReference |
| fld_ReceiverCustNoCarrier | Receivers Account No at Carrier | 11 | eSrkReceiverAccountAtCarrier |
| fld_SenderReference | Senders Reference | 12 | eSrkSenderReference |
| fld_InsCategory | Category | 18 | eSrkInsuranceCategory |
| fld_InsPolicy | PolicyNo | 19 | eSrkInsurancePolicyNumber |
| fld_RefDeliveryConditions | Delivery Conditions | 20 | eSrkDeliveryConditions |
| fld_GoodsKind | Goods Type | 25 | eSrkGoodsKind |
| fld_RefAttention | Attention | 27 | eSrkAttention |
| fld_KID | KID | 29 | eSrkKID |
| fld_CODKID | KID (COD) | 29 | eSrkKID |
| fld_InsContents | Contents | 30 | eSrkInsuranceContent |
| fld_InsEmail | 31 | eSrkInsuranceSenderEmail | |
| fld_RefAdditionalOrderNumbers | Additional ordernumbers | 32 | eSrkOrderNumberAdditional |
| fld_ShipmentCrossDockingID | CrossDockingID | 33 | eSrkCrossDockingID |
| fld_RoutingCode1 | Routing Code 1 | 34 | eSrkRoutingCode |
| fld_DPDService | DPD Service | 35 | eSrkDPDService |
| fld_DPDOSort | DPD O-Sort | 36 | eSrkDPDOSort |
| fld_DPDDSort | DPD D-Sort | 37 | eSrkDPDDSort |
| fld_DPDLot | DPD Lot | 38 | eSrkDPDLot |
| fld_DPDServiceMark | DPD Service Mark | 39 | eSrkDPDServiceMark |
| fld_DPDServiceInfo | DPD Service Info | 40 | eSrkDPDServiceInfo |
| fld_DPDVersion | DPD Version | 41 | eSrkDPDVersion |
| fld_DPDDDepot | DPD D-Depot | 42 | eSrkDPDDDepot |
| fld_DPDDestinationText | DPD Destination Text | 44 | eSrkDPDDestinationText |
| fld_DPDServiceCountryZIP | DPD Service code-Country-Recipient-ZIP | 45 | eSrkDPDServiceCountryZIP |
| fld_ShipmentPrinterKey | PrinterKey | 53 | eSrkImportPrinterKey |
| fld_CODAccountType | Account Type | 54 | eSrkCODAcountType |
| fld_RoutingCode2 | Routing Code 2 | 56 | eSrkRoutingCode2 |
| fld_ShipmentActorAlias | Actor Alias | 61 | eSrkActorAlias |
| fld_ShiCarrierCode | CarrierCode | 62 | eSrkCarrierCode |
| fld_CustomField1 | Custom Field 1 | 63 | eSrkCustomField1 |
| fld_CustomField2 | Custom Field 2 | 64 | eSrkCustomField2 |
| fld_CustomField3 | Custom Field 3 | 65 | eSrkCustomField3 |
| fld_CustomField4 | Custom Field 4 | 66 | eSrkCustomField4 |
| fld_CustomField5 | Custom Field 5 | 67 | eSrkCustomField5 |
| fld_CustomField6 | Custom Field 6 | 68 | eSrkCustomField6 |
| fld_CustomField7 | Custom Field 7 | 69 | eSrkCustomField7 |
| fld_CustomField8 | Custom Field 8 | 70 | eSrkCustomField8 |
| fld_CustomField9 | Custom Field 9 | 71 | eSrkCustomField9 |
| fld_CustomField10 | Custom Field 10 | 72 | eSrkCustomField10 |
| fld_PayerAgentNumber | Payer Agent Number | 73 | eSrkPayerAgentNo |
| fld_RefServiceInformation | Service Information | 75 | eSrkServiceInformation |
| fld_RoutingCode3 | Routing Code 3 | 76 | eSrkRoutingCode3 |
| fld_SenderAirportCode | Sender Airport Code | 77 | eSrkAirportCodeSender |
| fld_ReceiverAirportCode | Receiver Airport Code | 78 | eSrkAirportCodeReceiver |
| fld_RefSenderPalletAccount | Sender Pallet Account | 79 | eSrkSenderPalletAccount |
| fld_RefReceiverPalletAccount | Receiver Pallet Account | 80 | eSrkReceiverPalletAccount |
| fld_RefInvoiceCustomsCode | Customs Code | 81 | eSrkInvoiceCustomsCode |
| fld_ShipmentCODAccountIBAN | CODAccountIBAN | 82 | eSrkCODAccountIBAN |
| fld_ShipmentCODAccountBIC | CODAccountBIC | 83 | eSrkCODAccountBIC |
| fld_CustomField11 | Custom Field 11 | 84 | eSrkCustomField11 |
| fld_CustomField12 | Custom Field 12 | 85 | eSrkCustomField12 |
| fld_CustomField13 | Custom Field 13 | 86 | eSrkCustomField13 |
| fld_CustomField14 | Custom Field 14 | 87 | eSrkCustomField14 |
| fld_CustomField15 | Custom Field 15 | 88 | eSrkCustomField15 |
| fld_CustomField16 | Custom Field 16 | 89 | eSrkCustomField16 |
| fld_CustomField17 | Custom Field 17 | 90 | eSrkCustomField17 |
| fld_CustomField18 | Custom Field 18 | 91 | eSrkCustomField18 |
| fld_CustomField19 | Custom Field 19 | 92 | eSrkCustomField19 |
| fld_CustomField20 | Custom Field 20 | 93 | eSrkCustomField20 |
| fld_ShipmentCarrierSpecificRef1 | ShipmentCarrierSpecificRef1 | 98 | eSrkShipmentCarrierSpecific1 |
| fld_ShipmentCarrierSpecificRef2 | ShipmentCarrierSpecificRef2 | 99 | eSrkShipmentCarrierSpecific2 |
| fld_ShipmentCarrierSpecificRef3 | ShipmentCarrierSpecificRef3 | 100 | eSrkShipmentCarrierSpecific3 |
| fld_ShipmentCarrierSpecificRef4 | ShipmentCarrierSpecificRef4 | 101 | eSrkShipmentCarrierSpecific4 |
| fld_ShipmentCarrierSpecificRef5 | ShipmentCarrierSpecificRef5 | 102 | eSrkShipmentCarrierSpecific5 |
| fld_RefPickupStart | Pickup Start | 108 | eSrkPickupStartDatetime |
| fld_RefPickupEnd | Pickup End | 109 | eSrkPickupEndDatetime |
| fld_RefDeliveryStart | Delivery Start | 110 | eSrkDeliveryStartDatetime |
| fld_RefDeliveryEnd | Delivery End | 111 | eSrkDeliveryEndDatetime |
| fld_RoutingCode4 | Routing Code 4 | 115 | eSrkRoutingCode4 |
| fld_RoutingCode5 | Routing Code 5 | 116 | eSrkRoutingCode5 |
| fld_RoutingCode6 | Routing Code 6 | 117 | eSrkRoutingCode6 |
| fld_RoutingCode7 | Routing Code 7 | 118 | eSrkRoutingCode7 |
| fld_RoutingCode8 | Routing Code 8 | 119 | eSrkRoutingCode8 |
| fld_CarrierSpecificBlob | Carrier Specific Blob | 127 | eSrkCarrierSpecificBlob |
| fld_RefAdditionalRecRef | Additional receiver references | 128 | eSrkAdditionalReceiverReference |
| fld_SelectedReference | Selected Reference | 134 | eSrkSelectedReference |
| fld_RefErrorLabel | Error Label Info | 136 | eSrkErrorLabelData |
| fld_ThirdPartyInsPremium | Premium | 138 | eSrkThirdPartyInsurancePremium |
| fld_ThirdPartyInsContents | Contents | 139 | eSrkThirdPartyInsuranceContents |
| fld_ThirdPartyInsEmail | 140 | eSrkThirdPartyInsuranceEmail | |
| fld_ThirdPartyInsTerms | Terms | 141 | eSrkThirdPartyInsuranceTermsAccepted |
| fld_FactoryDefinedRef | FactoryDefined | 145 | eSrkFactoryDefinedReference |
| fld_ShiKeyNo | ShipmentKeyNo | 146 | eSrkShipmentKey |
| fld_ShipmentTrackingUrl | Tracking URL | 147 | eSrkTrackingUrl |
| fld_ShipmentBookingNumber | Shipment Booking Number | 149 | esrkShipmentBookingNumber |
| fld_ShipmentBookingAlternativeService | Shipment Booking Alternative Service | 150 | eSrkShipmentBookingAlternativeService |
| fld_CustomField21 | Custom Field 21 | 176 | eSrkCustomField21 |
| fld_CustomField22 | Custom Field 22 | 177 | eSrkCustomField22 |
| fld_CustomField23 | Custom Field 23 | 178 | eSrkCustomField23 |
| fld_CustomField24 | Custom Field 24 | 179 | eSrkCustomField24 |
| fld_CustomField25 | Custom Field 25 | 180 | eSrkCustomField25 |
| fld_CustomField26 | Custom Field 26 | 181 | eSrkCustomField26 |
| fld_CustomField27 | Custom Field 27 | 182 | eSrkCustomField27 |
| fld_CustomField28 | Custom Field 28 | 183 | eSrkCustomField28 |
| fld_CustomField29 | Custom Field 29 | 184 | eSrkCustomField29 |
| fld_CustomField30 | Custom Field 30 | 185 | eSrkCustomField30 |
| fld_CustomField31 | Custom Field 31 | 186 | eSrkCustomField31 |
| fld_CustomField32 | Custom Field 32 | 187 | eSrkCustomField32 |
| fld_CustomField33 | Custom Field 33 | 188 | eSrkCustomField33 |
| fld_CustomField34 | Custom Field 34 | 189 | eSrkCustomField34 |
| fld_CustomField35 | Custom Field 35 | 190 | eSrkCustomField35 |
| fld_CustomField36 | Custom Field 36 | 191 | eSrkCustomField36 |
| fld_CustomField37 | Custom Field 37 | 192 | eSrkCustomField37 |
| fld_CustomField38 | Custom Field 38 | 193 | eSrkCustomField38 |
| fld_CustomField39 | Custom Field 39 | 194 | eSrkCustomField39 |
| fld_CustomField40 | Custom Field 40 | 195 | eSrkCustomField40 |
| fld_CustomField41 | Custom Field 41 | 196 | eSrkCustomField41 |
| fld_CustomField42 | Custom Field 42 | 197 | eSrkCustomField42 |
| fld_CustomField43 | Custom Field 43 | 198 | eSrkCustomField43 |
| fld_CustomField44 | Custom Field 44 | 199 | eSrkCustomField44 |
| fld_CustomField45 | Custom Field 45 | 200 | eSrkCustomField45 |
| fld_CustomField46 | Custom Field 46 | 201 | eSrkCustomField46 |
| fld_CustomField47 | Custom Field 47 | 202 | eSrkCustomField47 |
| fld_CustomField48 | Custom Field 48 | 203 | eSrkCustomField48 |
| fld_CustomField49 | Custom Field 49 | 204 | eSrkCustomField49 |
| fld_CustomField50 | Custom Field 50 | 205 | eSrkCustomField50 |
| fld_CustomField51 | Custom Field 51 | 206 | eSrkCustomField51 |
| fld_CustomField52 | Custom Field 52 | 207 | eSrkCustomField52 |
| fld_CustomField53 | Custom Field 53 | 208 | eSrkCustomField53 |
| fld_CustomField54 | Custom Field 54 | 209 | eSrkCustomField54 |
| fld_CustomField55 | Custom Field 55 | 210 | eSrkCustomField55 |
| fld_CustomField56 | Custom Field 56 | 211 | eSrkCustomField56 |
| fld_CustomField57 | Custom Field 57 | 212 | eSrkCustomField57 |
| fld_CustomField58 | Custom Field 58 | 213 | eSrkCustomField58 |
| fld_CustomField59 | Custom Field 59 | 214 | eSrkCustomField59 |
| fld_CustomField60 | Custom Field 60 | 215 | eSrkCustomField60 |
Line reference fields
| fld_ Name | Display Label | KindID | Enum Name |
|---|---|---|---|
| fld_LContents | Contents | 23 | eSrkContents |
| fld_LMarking | Marking | 24 | eSrkMarking |
| fld_LineCarrierSpecificRef1 | LineCarrierSpecificRef1 | 103 | eSrkLineCarrierSpecific1 |
| fld_LineCarrierSpecificRef2 | LineCarrierSpecificRef2 | 104 | eSrkLineCarrierSpecific2 |
| fld_LineCarrierSpecificRef3 | LineCarrierSpecificRef3 | 105 | eSrkLineCarrierSpecific3 |
| fld_LineCarrierSpecificRef4 | LineCarrierSpecificRef4 | 106 | eSrkLineCarrierSpecific4 |
| fld_LineCarrierSpecificRef5 | LineCarrierSpecificRef5 | 107 | eSrkLineCarrierSpecific5 |
| fld_LCustomField1 | Custom Line Field 1 | 129 | eSrkCustomLineField1 |
| fld_LCustomField2 | Custom Line Field 2 | 130 | eSrkCustomLineField2 |
| fld_LCustomField3 | Custom Line Field 3 | 131 | eSrkCustomLineField3 |
| fld_LCustomField4 | Custom Line Field 4 | 132 | eSrkCustomLineField4 |
| fld_LCustomField5 | Custom Line Field 5 | 133 | eSrkCustomLineField5 |
| fld_LCustomField6 | Custom Line Field 6 | 221 | eSrkCustomLineField6 |
| fld_LCustomField7 | Custom Line Field 7 | 222 | eSrkCustomLineField7 |
| fld_LCustomField8 | Custom Line Field 8 | 223 | eSrkCustomLineField8 |
| fld_LCustomField9 | Custom Line Field 9 | 224 | eSrkCustomLineField9 |
| fld_LCustomField10 | Custom Line Field 10 | 225 | eSrkCustomLineField10 |
| fld_LCustomField11 | Custom Line Field 11 | 226 | eSrkCustomLineField11 |
| fld_LCustomField12 | Custom Line Field 12 | 227 | eSrkCustomLineField12 |
| fld_LCustomField13 | Custom Line Field 13 | 228 | eSrkCustomLineField13 |
| fld_LCustomField14 | Custom Line Field 14 | 229 | eSrkCustomLineField14 |
| fld_LCustomField15 | Custom Line Field 15 | 230 | eSrkCustomLineField15 |
| fld_LCustomField16 | Custom Line Field 16 | 231 | eSrkCustomLineField16 |
| fld_LCustomField17 | Custom Line Field 17 | 232 | eSrkCustomLineField17 |
| fld_LCustomField18 | Custom Line Field 18 | 233 | eSrkCustomLineField18 |
| fld_LCustomField19 | Custom Line Field 19 | 234 | eSrkCustomLineField19 |
| fld_LCustomField20 | Custom Line Field 20 | 235 | eSrkCustomLineField20 |