Shiptheory's integration with NetSuite allows you to override Shiptheory's own mappings of NetSuite data downloaded when pulling in an Item Fulfillment. Currently only mapping data from the Item Fulfillment and Sales Order are supported.
For example Shiptheory uses a set path to find a recipient's first name from NetSuite data. Using native field overrides we can change this path so that the recipient's first name on our Shiptheory shipment is pulled from another data point. In the below example we have specified that we want the value of the receiver's first name on our Shiptheory shipment to be pulled from shippingAddress.country and we want the value of the receiver's last name to be pulled from currency.name.
Path Syntax
The gift message path uses dot notation to dictate how to navigate through the JSON data Shiptheory downloads from NetSuite when processing your Item Fulfillments.
For example: shippingAddress.country would extract "_unitedStates." from the order data below:
{
"createdDate": "2023-08-04T02:28:10.000-07:00",
"lastModifiedDate": "2023-08-04T02:28:48.000-07:00",
"shippingAddress": {
"internalId": null,
"country": "_unitedStates",
"attention": null,
"addressee": "Aaron Abbott",
"addrPhone": "(303) 464-4122",
"addr1": "1500 Broadway",
"addr2": null,
"addr3": null,
"city": "Denver",
"state": "CO",
"zip": "80202",
"addrText": "Aaron Abbott\n1500 Broadway\nDenver CO 80202\nUnited States",
"override": false,
"customFieldList": null,
"nullFieldList": null
}
}Data path testing tool
We have a tool to help you build and test your data path, available here: https://helm.shiptheory.com/sandbox/find_data_path.
Simply copy-and-paste the JSON data from a NetSuite Shipment into the tool and you will be able to enter and test your data path before saving to your NetSuite settings.
The examples below will show the structure of the data we receive from NetSuite. You can use the examples and the data path tool to check and generate your paths. If you wish data from your own shipments, then contact our support team and they will assist you in retrieving it.
Example Item Fulfillment JSON
{
"createdDate": "2023-08-04T02:28:10.000-07:00",
"lastModifiedDate": "2023-08-04T02:28:48.000-07:00",
"customForm": {
"internalId": "148",
"externalId": null,
"type": null,
"name": "HM Item Fulfillment"
},
"postingPeriod": null,
"entity": {
"internalId": "1542",
"externalId": null,
"type": null,
"name": "Aaron Abbott"
},
"createdFrom": {
"internalId": "11868",
"externalId": null,
"type": null,
"name": "Sales Order #SLS00000629"
},
"requestedBy": null,
"createdFromShipGroup": 1,
"partner": null,
"shippingAddress": {
"internalId": null,
"country": "_unitedStates",
"attention": null,
"addressee": "Aaron Abbott",
"addrPhone": "(303) 464-4122",
"addr1": "1500 Broadway",
"addr2": null,
"addr3": null,
"city": "Denver",
"state": "CO",
"zip": "80202",
"addrText": "Aaron Abbott\n1500 Broadway\nDenver CO 80202\nUnited States",
"override": false,
"customFieldList": null,
"nullFieldList": null
},
"pickedDate": null,
"packedDate": null,
"shippedDate": null,
"shipIsResidential": false,
"shipAddressList": {
"internalId": "244955",
"externalId": null,
"type": null,
"name": "1500 Broadway"
},
"shipStatus": "_shipped",
"saturdayDeliveryUps": null,
"sendShipNotifyEmailUps": null,
"sendBackupEmailUps": null,
"shipNotifyEmailAddressUps": null,
"shipNotifyEmailAddress2Ups": null,
"backupEmailAddressUps": null,
"shipNotifyEmailMessageUps": null,
"thirdPartyAcctUps": null,
"thirdPartyZipcodeUps": null,
"thirdPartyCountryUps": null,
"thirdPartyTypeUps": null,
"partiesToTransactionUps": null,
"exportTypeUps": null,
"methodOfTransportUps": null,
"carrierIdUps": null,
"entryNumberUps": null,
"inbondCodeUps": null,
"isRoutedExportTransactionUps": null,
"licenseNumberUps": null,
"licenseDateUps": null,
"licenseExceptionUps": null,
"eccNumberUps": null,
"recipientTaxIdUps": null,
"blanketStartDateUps": null,
"blanketEndDateUps": null,
"shipmentWeightUps": null,
"saturdayDeliveryFedEx": null,
"saturdayPickupFedex": null,
"sendShipNotifyEmailFedEx": null,
"sendBackupEmailFedEx": null,
"signatureHomeDeliveryFedEx": null,
"shipNotifyEmailAddressFedEx": null,
"backupEmailAddressFedEx": null,
"shipDateFedEx": null,
"homeDeliveryTypeFedEx": null,
"homeDeliveryDateFedEx": null,
"bookingConfirmationNumFedEx": null,
"intlExemptionNumFedEx": null,
"b13aFilingOptionFedEx": null,
"b13aStatementDataFedEx": null,
"thirdPartyAcctFedEx": null,
"thirdPartyCountryFedEx": null,
"thirdPartyTypeFedEx": null,
"shipmentWeightFedEx": null,
"termsOfSaleFedEx": null,
"termsFreightChargeFedEx": null,
"termsInsuranceChargeFedEx": null,
"insideDeliveryFedEx": null,
"insidePickupFedEx": null,
"ancillaryEndorsementFedEx": null,
"holdAtLocationFedEx": null,
"halPhoneFedEx": null,
"halAddr1FedEx": null,
"halAddr2FedEx": null,
"halAddr3FedEx": null,
"halCityFedEx": null,
"halZipFedEx": null,
"halStateFedEx": null,
"halCountryFedEx": null,
"hazmatTypeFedEx": null,
"accessibilityTypeFedEx": null,
"isCargoAircraftOnlyFedEx": null,
"tranDate": "2023-08-04T00:00:00.000-07:00",
"tranId": "SHI00000411",
"shipMethod": null,
"generateIntegratedShipperLabel": null,
"shippingCost": null,
"handlingCost": 0,
"memo": null,
"transferLocation": null,
"packageList": {
"package": [
{
"packageWeight": 1,
"packageDescr": "Shiptheory Shipment: 11869 - SHI00000411",
"packageTrackingNumber": "11869"
},
{
"packageWeight": 1,
"packageDescr": "Shiptheory Shipment: 11869 - SHI00000411",
"packageTrackingNumber": "11869"
}
],
"replaceAll": true
},
"packageUpsList": null,
"packageUspsList": null,
"packageFedExList": null,
"itemList": {
"item": [
{
"jobName": null,
"itemReceive": true,
"itemName": "ACC00003",
"description": "Merlin display phone for support calls",
"department": null,
"class": null,
"location": {
"internalId": "2",
"externalId": null,
"type": null,
"name": "01: San Francisco"
},
"onHand": 41,
"quantity": 1,
"unitsDisplay": null,
"createPo": null,
"inventoryDetail": null,
"binNumbers": null,
"serialNumbers": null,
"poNum": null,
"item": {
"internalId": "502",
"externalId": null,
"type": null,
"name": "ACC00003"
},
"orderLine": 1,
"quantityRemaining": 1,
"options": null,
"shipGroup": null,
"itemIsFulfilled": null,
"shipAddress": null,
"shipMethod": null,
"customFieldList": null
},
{
"jobName": null,
"itemReceive": true,
"itemName": "ACC00002",
"description": "Digital Single Line Telephone ( 4400) for support calls",
"department": null,
"class": null,
"location": {
"internalId": "2",
"externalId": null,
"type": null,
"name": "01: San Francisco"
},
"onHand": 56,
"quantity": 1,
"unitsDisplay": "Ea",
"createPo": null,
"inventoryDetail": null,
"binNumbers": null,
"serialNumbers": null,
"poNum": null,
"item": {
"internalId": "501",
"externalId": null,
"type": null,
"name": "ACC00002"
},
"orderLine": 2,
"quantityRemaining": 1,
"options": null,
"shipGroup": null,
"itemIsFulfilled": null,
"shipAddress": null,
"shipMethod": null,
"customFieldList": null
}
],
"replaceAll": true
},
"accountingBookDetailList": null,
"customFieldList": {
"customField": [
{
"value": false,
"internalId": "4648",
"scriptId": "custbody_sent_to_shiptheory"
}
]
},
"internalId": "11869",
"externalId": null,
"nullFieldList": null
}Example Sales Order JSON
{
"createdDate": "2023-08-04T02:27:28.000-07:00",
"customForm": null,
"entity": {
"internalId": "1542",
"externalId": null,
"type": null,
"name": "Aaron Abbott"
},
"job": null,
"currency": {
"internalId": "1",
"externalId": null,
"type": null,
"name": "USA"
},
"drAccount": null,
"fxAccount": null,
"tranDate": "2023-08-04T00:00:00.000-07:00",
"tranId": "SLS00000629",
"entityTaxRegNum": null,
"source": null,
"createdFrom": null,
"orderStatus": null,
"nextBill": "2023-08-04T00:00:00.000-07:00",
"opportunity": null,
"salesRep": {
"internalId": "1008",
"externalId": null,
"type": null,
"name": "Mary Redding"
},
"contribPct": null,
"partner": null,
"salesGroup": null,
"syncSalesTeams": null,
"leadSource": null,
"startDate": null,
"endDate": null,
"otherRefNum": null,
"memo": null,
"salesEffectiveDate": null,
"excludeCommission": null,
"totalCostEstimate": null,
"estGrossProfit": null,
"estGrossProfitPercent": null,
"exchangeRate": 1,
"promoCode": null,
"currencyName": "USA",
"discountItem": null,
"discountRate": null,
"isTaxable": null,
"taxItem": null,
"taxRate": null,
"toBePrinted": false,
"toBeEmailed": false,
"email": "aa@fake-email.com",
"toBeFaxed": false,
"fax": null,
"messageSel": null,
"message": "The author and publisher disclaim any warranties (express or implied), merchantability, or fitness for any particular purpose. The author and publisher shall in no event be held liable to any party for any direct, indirect, punitive, special, incidental or other consequential damages arising directly or indirectly from any use of this material, which is provided \u201cas is\u201d, and without warranties.",
"paymentOption": null,
"inputAuthCode": null,
"inputReferenceCode": null,
"checkNumber": null,
"paymentCardCsc": null,
"paymentProcessingProfile": null,
"handlingMode": null,
"outputAuthCode": null,
"outputReferenceCode": null,
"paymentOperation": null,
"dynamicDescriptor": null,
"billingAddress": {
"internalId": null,
"country": "_unitedStates",
"attention": null,
"addressee": "Aaron Abbott",
"addrPhone": "(303) 464-4122",
"addr1": "1500 Broadway",
"addr2": null,
"addr3": null,
"city": "Denver",
"state": "CO",
"zip": "80202",
"addrText": "Aaron Abbott\n1500 Broadway\nDenver CO 80202\nUnited States",
"override": false,
"customFieldList": null,
"nullFieldList": null
},
"billAddressList": null,
"shippingAddress": {
"internalId": null,
"country": "_unitedStates",
"attention": null,
"addressee": "Aaron Abbott",
"addrPhone": "(303) 464-4122",
"addr1": "1500 Broadway",
"addr2": null,
"addr3": null,
"city": "Denver",
"state": "CO",
"zip": "80202",
"addrText": "Aaron Abbott\n1500 Broadway\nDenver CO 80202\nUnited States",
"override": false,
"customFieldList": null,
"nullFieldList": null
},
"shipIsResidential": false,
"shipAddressList": null,
"fob": null,
"shipDate": "2023-08-06T00:00:00.000-07:00",
"actualShipDate": "2023-08-04T00:00:00.000-07:00",
"shipMethod": null,
"shippingCost": null,
"shippingTax1Rate": null,
"isMultiShipTo": null,
"shippingTax2Rate": null,
"shippingTaxCode": null,
"handlingTaxCode": null,
"handlingTax1Rate": null,
"handlingTax2Rate": null,
"handlingCost": 0,
"trackingNumbers": null,
"linkedTrackingNumbers": "11869",
"shipComplete": false,
"paymentMethod": null,
"shopperIpAddress": null,
"saveOnAuthDecline": true,
"canHaveStackable": false,
"creditCard": null,
"revenueStatus": null,
"recognizedRevenue": null,
"deferredRevenue": null,
"revRecOnRevCommitment": null,
"revCommitStatus": null,
"ccNumber": null,
"ccExpireDate": null,
"ccName": null,
"ccStreet": null,
"ccZipCode": null,
"payPalStatus": null,
"creditCardProcessor": null,
"payPalTranId": null,
"ccApproved": null,
"getAuth": null,
"authCode": null,
"ccAvsStreetMatch": null,
"ccAvsZipMatch": null,
"isRecurringPayment": null,
"ccSecurityCodeMatch": null,
"altSalesTotal": null,
"ignoreAvs": null,
"paymentEventResult": null,
"paymentEventHoldReason": null,
"paymentEventType": null,
"paymentEventDate": null,
"paymentEventUpdatedBy": null,
"subTotal": 275,
"discountTotal": null,
"taxTotal": 0,
"altShippingCost": null,
"altHandlingCost": null,
"total": 275,
"revRecSchedule": null,
"revRecStartDate": null,
"revRecEndDate": null,
"paypalAuthId": null,
"balance": 0,
"paypalProcess": null,
"billingSchedule": null,
"ccSecurityCode": null,
"threeDStatusCode": null,
"class": null,
"department": null,
"subsidiary": {
"internalId": "1",
"externalId": null,
"type": null,
"name": "Honeycomb Mfg."
},
"intercoTransaction": null,
"intercoStatus": null,
"debitCardIssueNo": null,
"lastModifiedDate": "2023-08-04T02:28:10.000-07:00",
"nexus": null,
"subsidiaryTaxRegNum": null,
"taxRegOverride": null,
"taxPointDate": null,
"taxDetailsOverride": null,
"location": {
"internalId": "2",
"externalId": null,
"type": null,
"name": "01: San Francisco"
},
"pnRefNum": null,
"status": "Pending Billing",
"tax2Total": null,
"terms": {
"internalId": "2",
"externalId": null,
"type": null,
"name": "Net 30"
},
"validFrom": null,
"vatRegNum": null,
"giftCertApplied": null,
"oneTime": null,
"recurWeekly": null,
"recurMonthly": null,
"recurQuarterly": null,
"recurAnnually": null,
"tranIsVsoeBundle": null,
"vsoeAutoCalc": null,
"syncPartnerTeams": null,
"salesTeamList": null,
"partnersList": null,
"giftCertRedemptionList": null,
"promotionsList": null,
"itemList": {
"item": [
{
"job": null,
"subscription": null,
"item": {
"internalId": "502",
"externalId": null,
"type": null,
"name": "ACC00003"
},
"quantityAvailable": 36,
"expandItemGroup": false,
"lineUniqueKey": 35040,
"quantityOnHand": null,
"quantity": 1,
"units": null,
"inventoryDetail": null,
"description": "Merlin display phone for support calls",
"price": {
"internalId": "1",
"externalId": null,
"type": null,
"name": "List Price"
},
"rate": "175.00",
"serialNumbers": null,
"amount": 175,
"isTaxable": null,
"commitInventory": "_availableQty",
"orderPriority": null,
"licenseCode": null,
"options": null,
"department": null,
"class": null,
"location": null,
"createPo": null,
"createdPo": null,
"altSalesAmt": null,
"createWo": false,
"poVendor": null,
"poCurrency": null,
"poRate": null,
"revRecSchedule": null,
"revRecStartDate": null,
"revRecTermInMonths": null,
"revRecEndDate": null,
"deferRevRec": null,
"isClosed": null,
"itemFulfillmentChoice": null,
"catchUpPeriod": null,
"billingSchedule": null,
"fromJob": false,
"grossAmt": null,
"taxAmount": null,
"excludeFromRateRequest": null,
"isEstimate": false,
"inventoryLocation": null,
"inventorySubsidiary": null,
"line": 1,
"percentComplete": null,
"costEstimateType": null,
"costEstimate": null,
"quantityBackOrdered": null,
"quantityBilled": null,
"quantityCommitted": null,
"quantityFulfilled": null,
"quantityPacked": null,
"quantityPicked": null,
"tax1Amt": null,
"taxCode": {
"internalId": "-7",
"externalId": null,
"type": null,
"name": "-Not Taxable-"
},
"taxRate1": null,
"taxRate2": null,
"giftCertFrom": null,
"giftCertRecipientName": null,
"giftCertRecipientEmail": null,
"giftCertMessage": null,
"giftCertNumber": null,
"shipGroup": 1,
"itemIsFulfilled": true,
"shipAddress": null,
"shipMethod": null,
"vsoeSopGroup": null,
"vsoeIsEstimate": null,
"vsoePrice": null,
"vsoeAmount": null,
"vsoeAllocation": null,
"vsoeDeferral": null,
"vsoePermitDiscount": null,
"vsoeDelivered": null,
"expectedShipDate": null,
"noAutoAssignLocation": null,
"locationAutoAssigned": null,
"taxDetailsReference": null,
"chargeType": null,
"orderAllocationStrategy": null,
"requestedDate": null,
"customFieldList": null
},
{
"job": null,
"subscription": null,
"item": {
"internalId": "501",
"externalId": null,
"type": null,
"name": "ACC00002"
},
"quantityAvailable": 53,
"expandItemGroup": false,
"lineUniqueKey": 35041,
"quantityOnHand": null,
"quantity": 1,
"units": null,
"inventoryDetail": null,
"description": "Digital Single Line Telephone ( 4400) for support calls",
"price": {
"internalId": "1",
"externalId": null,
"type": null,
"name": "List Price"
},
"rate": "100.00",
"serialNumbers": null,
"amount": 100,
"isTaxable": null,
"commitInventory": "_availableQty",
"orderPriority": null,
"licenseCode": null,
"options": null,
"department": null,
"class": null,
"location": null,
"createPo": null,
"createdPo": null,
"altSalesAmt": null,
"createWo": false,
"poVendor": null,
"poCurrency": null,
"poRate": null,
"revRecSchedule": null,
"revRecStartDate": null,
"revRecTermInMonths": null,
"revRecEndDate": null,
"deferRevRec": null,
"isClosed": null,
"itemFulfillmentChoice": null,
"catchUpPeriod": null,
"billingSchedule": null,
"fromJob": false,
"grossAmt": null,
"taxAmount": null,
"excludeFromRateRequest": null,
"isEstimate": false,
"inventoryLocation": null,
"inventorySubsidiary": null,
"line": 2,
"percentComplete": null,
"costEstimateType": null,
"costEstimate": null,
"quantityBackOrdered": null,
"quantityBilled": null,
"quantityCommitted": null,
"quantityFulfilled": null,
"quantityPacked": null,
"quantityPicked": null,
"tax1Amt": null,
"taxCode": {
"internalId": "-7",
"externalId": null,
"type": null,
"name": "-Not Taxable-"
},
"taxRate1": null,
"taxRate2": null,
"giftCertFrom": null,
"giftCertRecipientName": null,
"giftCertRecipientEmail": null,
"giftCertMessage": null,
"giftCertNumber": null,
"shipGroup": 1,
"itemIsFulfilled": true,
"shipAddress": null,
"shipMethod": null,
"vsoeSopGroup": null,
"vsoeIsEstimate": null,
"vsoePrice": null,
"vsoeAmount": null,
"vsoeAllocation": null,
"vsoeDeferral": null,
"vsoePermitDiscount": null,
"vsoeDelivered": null,
"expectedShipDate": null,
"noAutoAssignLocation": null,
"locationAutoAssigned": null,
"taxDetailsReference": null,
"chargeType": null,
"orderAllocationStrategy": null,
"requestedDate": null,
"customFieldList": null
}
],
"replaceAll": true
},
"shipGroupList": null,
"accountingBookDetailList": null,
"taxDetailsList": null,
"customFieldList": {
"customField": [
{
"value": "aa@fake-email.com",
"internalId": "3148",
"scriptId": "custbody14"
}
]
},
"internalId": "11868",
"externalId": null,
"nullFieldList": null
}